API documentation

>>>

GET /api/hosts/:host_id/snapshots
List all snapshots

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
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, 'all' to return all results Validations: Must match regular expression `/\A([1-9]\d*\|all)\Z$/`.

Search fields

Field name	Type	Possible values
name	string

>>>

GET /api/hosts/:host_id/snapshots/:id
Show a snapshot

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

>>>

POST /api/hosts/:host_id/snapshots
Create a snapshot

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
include_ram optional	Whether to include the RAM state in the snapshot Validations: Must be one of: `true`, `false`, `1`, `0`.
snapshot required	Validations: Must be a Hash
snapshot[name] required	Name of this snapshot Validations: Must be a String
snapshot[description] optional , nil allowed	Description of this snapshot Validations: Must be a String

>>>

PUT /api/hosts/:host_id/snapshots/:id
Update a snapshot

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
snapshot required	Validations: Must be a Hash
snapshot[name] optional	Name of this snapshot Validations: Must be a String
snapshot[description] optional , nil allowed	Description of this snapshot Validations: Must be a String

>>>

DELETE /api/hosts/:host_id/snapshots/:id
Delete a snapshot

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

>>>

PUT /api/hosts/:host_id/snapshots/:id/revert
Revert Host to a snapshot

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
host_id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.
id required	Validations: Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.