Examples

GET /api/users/988725831/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-05-18 16:09:03 UTC",
      "updated_at": "2021-05-18 16:09:03 UTC",
      "id": 5,
      "name": "user9@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDch3UALb545N2wVyKGXjt7CF+PQwuOH+DCGS66xe2Ql2DS42X8jGtPh1u7ZRNcj9HjIUwQP4s4qhg3q6U3wvpYczYZYGsia4DtTLa9cUJ1fuI0RbH/z3rhCkoLQkGYfzro5xTxjwzNl2wXgGJXAvcnfzwmkggGqcj3WwkibtEu896GTLeSPxgEcXSymJYnsLlykGG40mTjNixhHFrGL+uxAEQePOjbcnpN04QcHuzY8ZiMf7dl+Uz8BfSNtQbMVpe0y+FG8EKEUN/2UIys3MidcViL1DX5qkbDaDvQtvTFNaSvhoRf1Jn9KPJhAoWJD+jnTnuhy/ZxbpX//4U25jqB foreman8@example.com",
      "length": 2048,
      "fingerprint": "RCeGoCzwYtKTMcMx1kuUFHNqQJcZndK8nQcspaGgOKM="
    }
  ]
}

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