Sign in

v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB
VPS

Get all VPS Snapshot Schedules for a Facility or VPS Instance

get/vps/snapshotSchedule

Query parameters

clientIdinteger

The unique client account ID.

deviceIdinteger

The unique device ID of the VPS instance.

facilityCodestring

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

Headers

X-Fieldsstring mask

An optional fields mask

Response

Success

dayinteger

The day of the month to run the snapshot process (1-28).

hourinteger

The hour of the day to run the snapshot process (0-23).

intervalTypestring

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

maxSnapshotsinteger

The maximum number of snapshots to take within the interval period.

minuteinteger

The minute of the hour to run the snapshot process (0-59).

snapshotScheduleIdstring

The unique ID associated with the snapshot schedule.

timezonestring

The timezone to use for the snapshot schedule in IANA format. Example: America/New_York.

volumeIdstring

The unique ID of the VPS instance volume to take a snapshot of.

weekdayinteger

The day of the week to run the snapshot process (1-7 with 1 being Monday).