Examples

GET /api/users/988725684/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-05-19 07:41:37 UTC",
      "updated_at": "2021-05-19 07:41:37 UTC",
      "id": 4,
      "name": "user12@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC/NDP6bBHAWfnn2S8Spo5TD1vnb4NMrJ7KX0xyk4PRzocsH152WlanonvWGcHtrNJfD0cqy2Jv04vdkOuo82NMP8m2J6SECUVTgZGTpGbRmIpCBH3Ma1oAfBf5SEgH31RSlH60eytp3PIFF8J5C7KSALTrBEFdSGeH22Zi/kZeOxEAb0d+9iV21pq4TIHEFCIuId+y27OP6nJgIDdcCeUK53wHMWZwkZgBL/L5QH+ECttmhTHGwkGnFqdbgG3mgnNAB/gEVX/u6fKCxdUGxaN67ueTqHVx2CqwP1/5pknYgU1Zb/baoNlnh09RqNEpoXtrUyaFRkNd7AyxTJ9UJFCd foreman12@example.com",
      "length": 2048,
      "fingerprint": "K9Wc3ZFsSnEkYtzov00tFFbXlRucGLSj6hgV7wPSpYg="
    }
  ]
}

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, ‘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