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": "2019-09-11 14:31:52 UTC",
      "updated_at": "2019-09-11 14:31:52 UTC",
      "id": 2,
      "name": "user2@example.com",
      "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC73jm3itxuHfeEboe6l/u35KFx3h2de9/PJ5OBblsIYLGC5h+AGw+4Ny8ggLAB5wYw/ks5xMoahAdIZ4yI0ecS09cdTMN7V1oVL/IFdFA+7VSKsK8j1SUbSJjeuX7tbeFYhYx/HG/qmn2x3/10huUqDp3AhdiLTHPV1wVYDlEK/mSoYJOSRns0oyQBYSvmG8TSMdjh6smyrLZU5PWK/Qo922WG8QkzzLmCx5TsSrmDHFbKBXnf88AsG9EVcF9VRxCJYagbCtszHKcc5QV7I7EyDlbP0QmRsfvfi1KPI/ozBcm5SJFIsTLyX/KEi0T8bYYfvKNUTUEkmzpjf6NfE1GF foreman2@example.com",
      "length": 2048,
      "fingerprint": "25:14:96:87:ef:f3:b4:52:83:94:bc:49:0b:0b:63:47"
    }
  ]
}

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

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 Tipo Possible values
name string
user_id integer