Ssh keys

>>>

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

Examples

GET /api/users/988725683/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-09-01 13:49:58 UTC",
      "updated_at": "2021-09-01 13:49:58 UTC",
      "id": 1,
      "name": "user10@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDsKPnEP5/J4UidBnP9ocCQCKSEn378k0CO542J6Xcb6H3cPWdqI6lJmCrj3a2t4UMkQ6Rb0H42dxOZuGv/gn3fI8Lh4f0Z39ACY7aDziN1gPxIRVsBvK6CJ2/1pDvQBU+qjj2s7lMvcL5DFohEoBIaUETgLqzfBetElE8iElV5Oig3WhUXAyEehTaO/1Lgob2olZNolvt4Zsx+Rjaf9/3l40ENjOSKAZWuuIRTYPC3y/VctssNDW2VkX6ouSlgBnl/LnydqlGmSmXuss9mrpFOQ0CWMdOISfJHqUFhWcdlxJZ8zfPkoOoEjQI1hqvqFVwmOD0exGU4bHjP3mIgqJdt foreman10@example.com",
      "length": 2048,
      "fingerprint": "mv/hJDsKhe4Nm+NOYIHYPQ+sKNenSwXsZb1fv7wdhhc="
    }
  ]
}

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. ‘id 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
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/6-user13example-com
200
{
  "created_at": "2021-09-01 13:50:00 UTC",
  "updated_at": "2021-09-01 13:50:00 UTC",
  "id": 6,
  "name": "user13@example.com",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCalmhR7aFBZ5lSJfSJkG2M+LddPtXyS9qLIp/LJEtUlIS6Ln9IQakxvQFQhQLjXREslAQg93cPwel+87EcjQZRXjcwT2cnlVtk9pNuvzw0PglbcGUgSN8fNX1BS2P+bT1WdvzKVODY5cq6Bky00FidCfY4CjHfvG3ok7cvuasmhz5KBbMiIvbspQ4+KR93r/WLJQDJmRGitDLUkqXM9KYYVB097qax0n21097Uq8u7+tuSZMsYfF5YncWSPCso2wnjY72XjKr3RfbD/TcCIbM+r1DY7+xP72gJKaFmfGoUNAdrPTOgD4HDXvednRVIiYnQP6YdnctWNESNH5bC22nB foreman13@example.com",
  "length": 2048,
  "fingerprint": "D7IczsA/Y5aDsQEmPDlqaJiyO9NM5CMPkk2r1or/LO0="
}

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": "2021-09-01 13:49:59 UTC",
  "updated_at": "2021-09-01 13:49:59 UTC",
  "id": 3,
  "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/988725687/ssh_keys/7-user14example-com
{
  "ssh_key": {}
}
200
{
  "id": 7,
  "name": "user14@example.com",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4A2JSkZnxtMt9BQPsaG5phJ9Skk8h8Ec8Vd4I/mCiXUiFXdio1vG2X9P8Qti5DEL6jWvSrHACnJeQYL6/sFNpAZp7Lyi47LnpbXyOsATKAsqwzw/12GNUk5t49VrAkrFgH7KVxdniZ5q9A0m0KUr7y1lCq/Vzsvc8ing919wIL+/nqnOkjvlQ1G39x0u+CDeWJcpzwsVvt7zOV7Q+oTeaCloPX3xnN1+2Dr7L/WCgmGmfPH1o3Ns3OmTsx+iv65s+vgwtjva9GocQQ9QH9ougB1WlQUTIe7+hB25ZYK8wQIEMxLOLXfUZKqRDfuSS2MyKcotLPaO6H7P2Idd0a43n foreman14@example.com",
  "fingerprint": "SDjRMO9XKKj+giZWUfmkHreclLss35Zg9gWlf4H/Rm8=",
  "user_id": 988725687,
  "length": 2048,
  "created_at": "2021-09-01T13:50:01.686Z",
  "updated_at": "2021-09-01T13:50:01.686Z"
}

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