Examples

GET /api/users/988725678/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2018-11-16 10:03:06 UTC",
      "updated_at": "2018-11-16 10:03:06 UTC",
      "id": 1,
      "name": "user1@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCzfVC+CVRjSl8nv+zQOAB/fCX2KKfkNAdxUJXToFSVpTk1vhsWmT+zKJG3lzOVz+fUdDiqsHCXETR/y2e9BGZANbRz/x/NNG8v2ycKxCNaA3htQKL4lr/yAC8aO5Ex5NcHvgziL/mdtSCi2kB4aMeVHzifJqmY2l7waOmToqC42NIiY/EGFrpvltr50NX4ZzUIQqDS774t1DRf2AWZNdmGbB8uS+QGcnOZm4bl2f11m8Dise0phbOEjgu7b09BNGqRII0TN9aFvIRR3oostC9pYnl8O5BOFi5tFgA0hn0I11kNxMjpodivYF6WpZEFmotLDY84vWqdxkIycHscMB4X foreman1@example.com",
      "length": 2048,
      "fingerprint": "6e:2a:d1:f0:c5:4f:9a:77:73:15:46:b6:e0:89:53:29"
    }
  ]
}

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