VPS

Create a VPS Volume Snapshot

post/vps/snapshot

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/vps/snapshot
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

Request body

clientIdinteger

The unique client account ID.

facilityCodestring required

The facility code associated with the VPS instance. For example:TPA1.

namestring required

The name of the VPS instance snapshot.

volumeIdstring required

The unique VPS instance volume ID the snapshot is taken of.

Response

Success

clientIdinteger

Unique ID of the client triggering the task.

deviceIdinteger

Unique ID of the target device.

metaDatastring

Key value arguments used to trigger the task.

resultstring

Success|Pending|Failed. Null value also means Pending.

taskCreatedobject

Timestamp of task creation date.

taskIdstring

Unique ID of the network task.

taskUpdatedobject

Timestamp of most recent activity taken on the network task. This will update multiple times for multi-step tasks.

Changes

No recorded changes to this operation across all 1 revision of this API.