API documentation

>>>

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: 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	paginate results Validations: Must be a String
per_page optional	number of entries per request Validations: Must be a 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: Must be a Integer
organization_id optional	Scope by organizations Validations: Must be a Integer
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
user_id required	ID of the user Validations: Must be a 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: 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
ssh_key required	Validations: Must be a Hash
ssh_key[name] required	Validations: Must be a String
ssh_key[key] required	Public SSH key Validations: Must be a 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: Must be a Integer
organization_id optional	Scope by organizations Validations: Must be a Integer
id required	Validations: Must be a String
user_id required	ID of the user Validations: Must be a String