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-15 19:01:28 UTC",
      "updated_at": "2018-11-15 19:01:28 UTC",
      "id": 1,
      "name": "user1@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCrKErfOEcwln07iYNSZPn5YNTe59foGgZZ37GNwWc1A8RlksGAZbUxY7PDUlKH0SQgG9nylubyLp19Jz+i8DZYan448uOs3trWgivwu69XqoO2DSnOm1BP8qAuvD6djbFttQAuIVtLr4W4PZKUwFecet9FBpqQTHi/JqcSSfYPwpOaxu4O+BY4uObjW6lDiVvq4mNGpm9fcwc3dugsLLGaMkBa64z3GWj4XCTIus3i4B3K8r5A+ut7om/XgWrHf/EEFncXZ+MA6FdaWGb5Y9aJKGiYljmwX/YtmZP9T4Nis5XzoiUyUAbe0G+v3wZOMWs4CQQJpzMKPwQcFSV2+Wrd foreman1@example.com",
      "length": 2048,
      "fingerprint": "de:d5:2d:e8:0b:8a:f0:1c:50:7c:8c:71:42:77:44:cf"
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

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

paginate results

Validations:

  • Must be a String

per_page
optional

number of entries per request

Validations:

  • Must be a String

Search fields

Field name Type Possible values
name string
user_id integer