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