VPS Snapshots

This endpoint collection is still in beta and is subject to change

From the Cloudstack documentation:

CloudStack supports snapshots of disk volumes. Snapshots are a point-in-time capture of virtual machine disks. Memory and CPU states are not captured. If you are using the Oracle VM hypervisor, you can not take snapshots, since OVM does not support them.

Snapshots may be taken for volumes, including both root and data disks (except when the Oracle VM hypervisor is used, which does not support snapshots). The administrator places a limit on the number of stored snapshots per user. Users can create new volumes from the snapshot for recovery of particular files and they can create templates from snapshots to boot from a restored disk.

Users can create snapshots manually or by setting up automatic recurring snapshot policies. Users can also create disk volumes from snapshots, which may be attached to a VM like any other disk volume. Snapshots of both root disks and data disks are supported. However, CloudStack does not currently support booting a VM from a recovered root disk. A disk recovered from snapshot of a root disk is treated as a regular data disk; the data on recovered disk can be accessed by attaching the disk to a VM.

A completed snapshot is copied from primary storage to secondary storage, where it is stored until deleted or purged by newer snapshot.

Route: /api/v2/vps/snapshot

This resource is used to manage VPS snapshots.

Method: GET - Get all VPS Volume Snapshots available

This method will pull an array of VPS volume snapshots available.

Parameters

Sample Request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/snapshot?facilityCode=$facilityCode' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response (200)

[
  {
    "size": 0,
    "snapshotId": "string",
    "snapshotType": "string",
    "name": "string",
    "createdAt": "2023-07-11T19:11:54.414Z",
    "volumeId": "string",
    "state": "string"
  }
]

Response Codes

Method: POST - Create a VPS Volume Snapshot

This method will create a new VPS instance snapshot when provided with the following parameters

Parameters

Sample Request

curl -X 'POST' \
  'https://core.hivelocity.net/api/v2/vps/snapshot' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json' \
  -H 'content-type: application/json'
  -d{
  "volumeId": "string",
  "name": "string",
  "clientId": 0,
  "facilityCode": "string"
}

Sample Response (201)

{
  "result": "string",
  "metaData": "string",
  "taskId": "string",
  "taskCreated": {},
  "deviceId": 0,
  "taskUpdated": {},
  "clientId": 0
}

Response Codes

Route: /api/v2/vps/snapshot/<string:snapshotId>

This is a resource to manage VPS instance snapshots.

Method: GET - Get a VPS snapshot by snapshot ID

Provided with a valid facility code and VPS instance snapshot ID, this method will return the details of the specified snapshot ID.

Parameters

Sample Request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/snapshot/$snapshotId' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response (200)

{
  "size": 0,
  "snapshotId": "string",
  "snapshotType": "string",
  "name": "string",
  "createdAt": "2023-07-11T19:19:08.166Z",
  "volumeId": "string",
  "state": "string"
}

Response Codes

Method: POST - Restore a VPS volume snapshot

Provided with a valid facility code and snapshot ID, the VPS instance volume associated will be restored with the snapshot ID provided in this method.

Parameters

Sample Request

curl -X 'POST' \
  'https://core.hivelocity.net/api/v2/vps/snapshot/$snapshotId' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json' \
  -H 'content-type: application/json'
  -d{
  "facilityCode": "string",
  "clientId": 0
}

Sample Response (201)

{
  "result": "string",
  "metaData": "string",
  "taskId": "string",
  "taskCreated": {},
  "deviceId": 0,
  "taskUpdated": {},
  "clientId": 0
}

Response Codes

Method: DELETE - Delete a VPS volume snapshot

This method will delete a VPS instance volume snapshot when provided with the facility code and snapshot ID.

Parameters

Sample Request

curl -X 'DELETE' \
  'https://core.hivelocity.net/api/v2/vps/snapshot/$snapshotId' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response (201)

{
  "result": "string",
  "metaData": "string",
  "taskId": "string",
  "taskCreated": {},
  "deviceId": 0,
  "taskUpdated": {},
  "clientId": 0
}

Response Codes

Route: /api/v2/vps/snapshotSchedule

This is a resource to manage VPS snapshot schedules.

Method: GET - Get all VPS Snapshot Schedules for a Facility or VPS Instance

Provided with a valid facility code and VPS instance device ID, this method will return the array of snapshot schedules for the VPS instance provided.

Parameters

Sample Request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/snapshotSchedule?deviceId=$deviceId' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response (200)

[
  {
    "day": 0,
    "snapshotScheduleId": "string",
    "intervalType": "string",
    "maxSnapshots": 0,
    "minute": 0,
    "timezone": "string",
    "weekday": 0,
    "volumeId": "string",
    "hour": 0
  }
]

Response Codes

Method: POST - Create a VPS Snapshot Schedule

This method will create a schedule for the VPS instance snapshot when provided with the following parameters

Parameters

Sample Request

curl -X 'POST' \
  'https://core.hivelocity.net/api/v2/vps/snapshotSchedule' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json' \
  -H 'content-type: application/json'
  -d{
  "maxSnapshots": 0,
  "clientId": 0,
  "minute": 0,
  "facilityCode": "string",
  "day": 0,
  "volumeId": "string",
  "weekday": 0,
  "hour": 0,
  "intervalType": "string",
  "timezone": "string"
}

Sample Response (200)

{
  "day": 0,
  "snapshotScheduleId": "string",
  "intervalType": "string",
  "maxSnapshots": 0,
  "minute": 0,
  "timezone": "string",
  "weekday": 0,
  "volumeId": "string",
  "hour": 0
}

Response Codes

Route: /api/v2/vps/snapshotSchedule/<string:snapshotScheduleId>

This is a resource used to manage VPS snapshot schedules.

Method: GET - Get the snapshot schedule(s) for a VPS instance

When provided with a valid facility code and snapshot schedule ID, this method will return the details of the specified VPS instance snapshot schedule ID.

Parameters

Sample Request

curl -X 'GET' \
  'https://core.hivelocity.net/api/v2/vps/snapshotSchedule/$snapshotScheduleId' \
  -H "X-API-KEY: $API_KEY" \
  -H 'accept: application/json'

Sample Response (200)

{
  "day": 0,
  "snapshotScheduleId": "string",
  "intervalType": "string",
  "maxSnapshots": 0,
  "minute": 0,
  "timezone": "string",
  "weekday": 0,
  "volumeId": "string",
  "hour": 0
}

Response Codes

Method: DELETE - Delete a VPS Snapshot Schedule

When provided with a valid facility code and snapshot schedule ID, this method will delete the specified VPS instance snapshot schedule ID.

Parameters

Sample Request

curl -X 'DELETE' \
  'https://core.hivelocity.net/api/v2/vps/snapshotSchedule/$snapshotScheduleId?facilityCode=$facilityCode' \
  -H "X-API-KEY: $API_KEY"
  -H 'accept: application/json'

Response Codes