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": "2022-09-06 14:35:05 UTC",
      "updated_at": "2022-09-06 14:35:05 UTC",
      "id": 5,
      "name": "user6@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDb7i6RsDKOxIyYEk/VgLqqQkspXR9K0f/RhQ8S9caS8pVdLHtTWN1ZZAcNVIFvkHFBR8EuBn0MaIR0lucChGvf2bZjP+AzCqiH7mFFfFOmyo58t7VZIde1liohMRJruuy1AsZMrz3GoBBFkUe9wwpWwTn/EQJ9EVp133oA3jYok9jqXHAucr5QYDBn0VNTFmKdSCA3fUmbVOE9ZV9k8HVGAMXtm6QamBHVmLTAF6V+QfXtwgxJESXmCjJbzlkhdJbz+QNn6PQLUbdXMkrPpg4QZXxaatT+xT83mcwebWBSEFoVbFJ4lQMV3VMhlP36oD5rQ9H3N6q3FCboHtFaT/Tv foreman6@example.com",
      "length": 2048,
      "fingerprint": "RosxGWgXLARSlTh+I3okI9S2NqQU1NhnMlaOabFTrl8="
    }
  ]
}

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