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