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	filtra els resultats 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	Nombre de resultats per pàgina a retornar Validations: Must be a number.

Search fields

Field name	Tipus	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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	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 , <span class="translation_missing" title="translation missing: ca.apipie.nil_allowed">Nil Allowed</span>	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.