GET /api/users/:user_id/ssh_keys
List all SSH keys for a user

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

search
optional

filter results

Validations:

  • String

order
optional

sort results

Validations:

  • String

page
optional

paginate results

Validations:

  • String

per_page
optional

number of entries per request

Validations:

  • String

Search fields

Field name Type Possible values
name string
user_id integer

GET /api/users/:user_id/ssh_keys/:id
Show an SSH key from a user

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..

user_id
required

ID of the user

Validations:

  • String


POST /api/users/:user_id/ssh_keys
Add an SSH key for a user

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

user_id
required

ID of the user

Validations:

  • String

ssh_key
required

Validations:

  • Hash

ssh_key[name]
required

Validations:

  • String

ssh_key[key]
required

Public SSH key

Validations:

  • String


DELETE /api/users/:user_id/ssh_keys/:id
Delete an SSH key for a user

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer

organization_id
optional

Scope by organizations

Validations:

  • Integer

id
required

Validations:

  • String

user_id
required

ID of the user

Validations:

  • String