Examples

GET /api/users/988725765/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-11-07 08:34:21 UTC",
      "updated_at": "2019-11-07 08:34:21 UTC",
      "id": 7,
      "name": "user5@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDqU15t/OmNTpGmrUR580X5GgjpcZuH30MW685EuFOnUdQ/G50Q1viVWJF3Z1rbT9pPbhpkU76A7wL301iCa6KNz4hdA2Dr9k0e9/LCOIiX8VJ+wmtqW38XjeUs743Hk6Kks03Y2ffFUJzbu3NSL7Rpbl0i7OOHDDSE14Xkgy2iypR8YJaxup4IFMQVqFjUsvMmNqu5F8MqQXeKFjCcmvTmy73Keut3j/upV8mbGG3Tuv4cFz17Ljwx34UWeOjm6mxrInabNbT6QU0U41SkNIen/LYpWr3k0pDfBJg3ldYIin+ByBUTbSwqtqMbBPC/HguW5D3sYGUbNDn13++nwjT3 foreman5@example.com",
      "length": 2048,
      "fingerprint": "ff:78:1c:b2:8a:58:0d:50:34:c2:f7:1d:76:95:c2:23"
    }
  ]
}

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 field and order, eg. ‘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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
name string
user_id integer