Examples

GET /api/users/988725723/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2020-11-04 14:17:51 UTC",
      "updated_at": "2020-11-04 14:17:51 UTC",
      "id": 2,
      "name": "user3@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDU6SP5IuFwTo3S8FO6toCoBhYrnrL+DTYUz9IykNuOxk3ws2ML1qsWC40sOV8DUNSZvfD7KOPorWHM0l5hdskJM5whWEBx/XmcdNlrrmLM+hh673eARx4umxq6LdAktNqkaAkyW2cQvCS6m0P+8/mcsfFAl/R2hZCHZuQJ99ohrFzY/HZ9jwiAxoZ20lf6MMBz4GfRd2aXvjyzmJ4bXEiy3tRkMy1+IzV20AhLgO4kEY46zT9qXkOgwKSS2Ufp4w5RKxMSTST7Gf/R9ltG27QhETWkAWm2eLleVU0+EGTsvSRltbyOnj71maxG1MHYv//NDKz9N6+im2+GSj5MObeT foreman2@example.com",
      "length": 2048,
      "fingerprint": "xpxdcLtz/cveE7rQI7EkFNxK+3bmmABlSUOZekBcnbc="
    }
  ]
}

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