Examples

GET /api/users/988725680/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2021-11-26 09:57:33 UTC",
      "updated_at": "2021-11-26 09:57:33 UTC",
      "id": 5,
      "name": "user6@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC67QNsOpzfZfsvXYGac4fppAISkodVtZ6rlpT+/2b4MkmuwUyXThc1qsMV/sWG5Fjb5XrBWBr+/g1K8ZYDbvu2nEJ/20x9lo/NjGrJk+kMMuyzyQkvBY09n/8kxtEqW+yUqsWChgx5aTc36Cxm7IGLadSrFeKMfvWr1n28sueyKIlPKg5Ir5h+T5IGiuJD1iMqRCbGzwLLZZS0fjg4UKcgcb02XsXFSoHJcnwIifc3qPC05qQQFiTXtEDJMnv3FUCz4GkNxNb1boMyI1AHWjBTBX7YgFcwxBY/2QtzpJt1RRTdolUlFOwndblp1Vop+NsOTpfII/pcKlnczquhF/2B foreman6@example.com",
      "length": 2048,
      "fingerprint": "aB+pZA04nuWMmqX1ZcYh4Wo9C2m80kNibBO0bEnZto0="
    }
  ]
}

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. ‘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