---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Create a VPS Snapshot Schedule

Additional details can be found here: [VPS Snapshots](https://developers.hivelocity.net/docs/vps-snapshots)

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/vps/snapshotSchedule": {
      "post": {
        "operationId": "post_vps_snapshot_schedule_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VPSSnapshotScheduleCreate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VPSSnapshotSchedule"
                }
              }
            }
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          }
        },
        "summary": "Create a VPS Snapshot Schedule",
        "tags": [
          "VPS"
        ]
      }
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Endpoints to manage Virtual Private Servers",
      "name": "VPS"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "VPSSnapshotSchedule": {
        "properties": {
          "day": {
            "description": "The day of the month to run the snapshot process (1-28).",
            "type": "integer"
          },
          "hour": {
            "description": "The hour of the day to run the snapshot process (0-23).",
            "type": "integer"
          },
          "intervalType": {
            "description": "Snapshot interval options: HOURLY, DAILY, WEEKLY, MONTHLY.",
            "type": "string"
          },
          "maxSnapshots": {
            "description": "The maximum number of snapshots to take within the interval period.",
            "type": "integer"
          },
          "minute": {
            "description": "The minute of the hour to run the snapshot process (0-59).",
            "type": "integer"
          },
          "snapshotScheduleId": {
            "description": "The unique ID associated with the snapshot schedule.",
            "type": "string"
          },
          "timezone": {
            "description": "The timezone to use for the snapshot schedule in IANA format. Example: America/New_York.",
            "type": "string"
          },
          "volumeId": {
            "description": "The unique ID of the VPS instance volume to take a snapshot of.",
            "type": "string"
          },
          "weekday": {
            "description": "The day of the week to run the snapshot process (1-7 with 1 being Monday).",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "VPSSnapshotScheduleCreate": {
        "properties": {
          "clientId": {
            "description": "The unique client account ID.",
            "type": "integer"
          },
          "day": {
            "description": "The day of the month to run th snapshot process (1-28). This is required for Monthly.",
            "type": "integer"
          },
          "facilityCode": {
            "description": "The facility code associated witht he VPS instance. For example:TPA1.",
            "type": "string"
          },
          "hour": {
            "description": "The hour of the day to run the snapshot process (0-23).",
            "type": "integer"
          },
          "intervalType": {
            "description": "Options: `DAILY`, `WEEKLY`, `MONTHLY`",
            "type": "string"
          },
          "maxSnapshots": {
            "description": "The maximum number of snapshots to retain at a time for this schedule.",
            "type": "integer"
          },
          "minute": {
            "description": "The minute of the hour to run the snapshot process (0-59).",
            "type": "integer"
          },
          "timezone": {
            "description": "Timezone in IANA format. Example: `America/New_York`",
            "type": "string"
          },
          "volumeId": {
            "description": "The unique ID of the VPS instance volume to take a snapshot of.",
            "type": "string"
          },
          "weekday": {
            "description": "The day of the week to run the snapshot process (1-7 with 1 being Monday). This is required for Weekly.",
            "type": "integer"
          }
        },
        "required": [
          "facilityCode",
          "hour",
          "intervalType",
          "maxSnapshots",
          "minute",
          "timezone",
          "volumeId"
        ],
        "type": "object"
      }
    }
  }
}
```