Examples

GET /api/users/988725681/ssh_keys
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2020-05-20 13:36:04 UTC",
      "updated_at": "2020-05-20 13:36:04 UTC",
      "id": 6,
      "name": "user14@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC+OE271mxb31sEmQl8SqZl712GOByy+b1VE6xhny7sYAfvh18qiUlSgSX6L8rDS/1Fp1RsCOXaOcrQBpOGrwBP3xusb5bMWNJ9IxyDNM/zR+mxX2c1mvCIEuvbJsHydAK1a7MQNBStrzMpGUHIr7TVGazvbAJQl5Cm+Uon65mq+DCpDVClC3cVkgIwwDYrX1d+RCu97VcuMRXbctv96tZU06XaVES2mHynJgKgDE05oZg4lu+kQgRgl5w3JPjgY6+1GIzdbop04CVWapkchCocvG/w8YBhFbrdMps6zurkcqT1zlAvlpfQU+XgB7cdITSWmlzH/lIPIRYNxM9arSch foreman14@example.com",
      "length": 2048,
      "fingerprint": "WdYhP96M47rtqn+59uBdDRy0JKIx0Pqa4eh08+PkfsM="
    }
  ]
}

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

Validations:

  • Must be a number.

Search fields

Field name Type Possible values
name string
user_id integer