---
title: "Create a VPS Snapshot Schedule"
method: POST
path: "/vps/snapshotSchedule"
tags: ["VPS"]
---

# Create a VPS Snapshot Schedule

`POST /vps/snapshotSchedule`

## Headers

- `X-Fields` string, mask

## Request body

- VPSSnapshotScheduleCreate
  - `clientId` integer — The unique client account ID.
  - `day` integer — The day of the month to run th snapshot process (1-28). This is required for Monthly.
  - `facilityCode` string, required — The facility code associated witht he VPS instance. For example:TPA1.
  - `hour` integer, required — The hour of the day to run the snapshot process (0-23).
  - `intervalType` string, required — Options: `DAILY`, `WEEKLY`, `MONTHLY`
  - `maxSnapshots` integer, required — The maximum number of snapshots to retain at a time for this schedule.
  - `minute` integer, required — The minute of the hour to run the snapshot process (0-59).
  - `timezone` string, required — Timezone in IANA format. Example: `America/New_York`
  - `volumeId` string, required — The unique ID of the VPS instance volume to take a snapshot of.
  - `weekday` integer — The day of the week to run the snapshot process (1-7 with 1 being Monday). This is required for Weekly.

## Response `200`

Success

- VPSSnapshotSchedule
  - `day` integer — The day of the month to run the snapshot process (1-28).
  - `hour` integer — The hour of the day to run the snapshot process (0-23).
  - `intervalType` string — Snapshot interval options: HOURLY, DAILY, WEEKLY, MONTHLY.
  - `maxSnapshots` integer — The maximum number of snapshots to take within the interval period.
  - `minute` integer — The minute of the hour to run the snapshot process (0-59).
  - `snapshotScheduleId` string — The unique ID associated with the snapshot schedule.
  - `timezone` string — The timezone to use for the snapshot schedule in IANA format. Example: America/New_York.
  - `volumeId` string — The unique ID of the VPS instance volume to take a snapshot of.
  - `weekday` integer — The day of the week to run the snapshot process (1-7 with 1 being Monday).

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/versions/ee6b717b5015/schema)