Ssh keys

>>>

GET /api/users/:user_id/ssh_keys
List all SSH keys for a user

Examples

GET /api/users/988725687/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2022-03-29 08:37:23 UTC",
      "updated_at": "2022-03-29 08:37:23 UTC",
      "id": 6,
      "name": "user8@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCt153Xq10PTMHNZw6upjEIntEALYneya93zNrA5lLxF015hA0uurWpTKgD7DXa4vLk5nDXVXkx79U0VtmRyEfNUliQBj2lbvscdPXeyWIoUZ3e7gYox8aAi7FFxjP89/O1VXbIwMEPSDLAhb/lVa8uTpqIeTyKNHrBuqK1M50d3w9U7ur0Cf0a6rfPPPA8JIzFvjIuiDp8se7JMqcQ8IjaNFvDquP0SXbBo9URjq+RWJBXwwSfXJ1bJFbzER2n1kpTed+E2naticd+j5YdyHecBS34M8ekw/LbmYLJ25NmQxJLTxwqQ5ASbo69ZG824467fICTCn8B9IFI/fmewitD foreman8@example.com",
      "length": 2048,
      "fingerprint": "tLoethFHhwBUiQCsGsz0LnB62z4MOkDelJEpSlI948k="
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
required

ID of the user

Validations:

  • Must be a String
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
id integer
name string
user_id integer
>>>

GET /api/users/:user_id/ssh_keys/:id
Show an SSH key from a user

Examples

GET /api/users/988725686/ssh_keys/5-user7example-com
200
{
  "created_at": "2022-03-29 08:37:23 UTC",
  "updated_at": "2022-03-29 08:37:23 UTC",
  "id": 5,
  "name": "user7@example.com",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC0KJX1j53QeNRhDqvfjoLSgnZzqZorA5hAQAO8LmSdneIf+G4mkhE+n4/6eaSBdszOAK8uWnmOXbhsIkh7AWOs1uoW6ZcTcuaSbBS+2TWQUL7jn/um4VMSvadqqAF1+XIIB9WXa2cZHy6P7pqJG+5l3VCK7tuqJj0PJUwbeBFJPQc1ZMyPYA5Qf2x4ghGGXUzdfvaIKm0yPLQo1hXpM6vSziJRwf4bbf3sCl7W8ouaAuRX32xSS1bLi32nb+CR2jC1KTCHHUK9RRAgFKaEHV0swDr9bAM4PwWa5lNDIYORG3zlFaJ9MJ6RH5G3IWE2PBWK63g5dm4BsjzdN9RxsnxB foreman7@example.com",
  "length": 2048,
  "fingerprint": "4zoqgeZa7QHt4t3HEhI50PeiuxTkNO54KqZetMrWGqo="
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
user_id
required

ID of the user

Validations:

  • Must be a String
>>>

POST /api/users/:user_id/ssh_keys
Add an SSH key for a user

Examples

POST /api/users/988725684/ssh_keys
{
  "ssh_key": {
    "name": "foreman@example.com",
    "key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBIhRoL6PfBRs9YwW3r2/pYeLrxRzEZSUO3Go8JivxMsguEKjJ3byHDPvPpMHhKKSZD/HJY/A+2Ndqp0ElB+t2qs= foreman@example.com"
  }
}
201
{
  "created_at": "2022-03-29 08:37:22 UTC",
  "updated_at": "2022-03-29 08:37:22 UTC",
  "id": 2,
  "name": "foreman@example.com",
  "key": "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBIhRoL6PfBRs9YwW3r2/pYeLrxRzEZSUO3Go8JivxMsguEKjJ3byHDPvPpMHhKKSZD/HJY/A+2Ndqp0ElB+t2qs= foreman@example.com",
  "length": 520,
  "fingerprint": "5YShdnIX3EEv8GzgY2BSVyOmR9ADnS71FpyobuNljxk="
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
user_id
required

ID of the user

Validations:

  • Must be a String
ssh_key
required

Validations:

  • Must be a Hash
ssh_key[name]
required

Validations:

  • Must be a String
ssh_key[key]
required

Public SSH key

Validations:

  • Must be a String
>>>

DELETE /api/users/:user_id/ssh_keys/:id
Delete an SSH key for a user

Examples

DELETE /api/users/988725688/ssh_keys/7-user9example-com
{
  "ssh_key": {}
}
200
{
  "id": 7,
  "name": "user9@example.com",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCivPk9ntZhQRNVlQXJbtUtArzCIW9Gc7MNqiKgAnXtdjaw/N4NuQYCvu2eEX2IxSZI0V34D4i8eZPefJFQaJzb88CGcocf3iXk8/i45HSYRA22Ux1QiNRqTEU1nFM2NGt4k8hul4gi9rfW+6cT30LWTwrz1wBRLRDEGZmMPGkKitJQ4HTTpG9uq5rb77K11QiDVChyierJOrbiq3FonZztRslLCg8WDoRj9mdQukRmfurlN9hpnvYqo2NWfLhEoj8Xns0Z/dQKASebwTLoNwC3Ji3DyHz1Z5lp4gDcQ132Hc4P53fhfogV8lgrUWLOkHdEFGOWy8U606i/qMOf4Vkx foreman9@example.com",
  "fingerprint": "fZO6rF4wBuPFx0jbpKZP1tRnnm4bhOrzeidGoqzqwXQ=",
  "user_id": 988725688,
  "length": 2048,
  "created_at": "2022-03-29T08:37:24.406Z",
  "updated_at": "2022-03-29T08:37:24.406Z"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be a String
user_id
required

ID of the user

Validations:

  • Must be a String