v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB
VPS

Get a VPS Volume Snapshot by ID

get/vps/snapshot/{snapshotId}

Query parameters

clientIdinteger

The unique client account ID.

facilityCodestring

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

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

createdAtstring date-time

The created date/tie of the VPS instance snapshot.

namestring

The name of the VPS instance snapshot.

sizeinteger

Snapshot size in bytes

snapshotIdstring

The unique ID associated with the snapshot.

snapshotTypestring

Snapshot interval options: HOURLY, DAILY, WEEKLY, MONTHLY.

statestring

The state of the snapshot ie. Scheduled, Started or Completed.

volumeIdstring

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