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

# Create a VPS Volume Snapshot

`POST /vps/snapshot`

## Headers

- `X-Fields` string, mask

## Request body

- VPSSnapshotCreate
  - `clientId` integer — The unique client account ID.
  - `facilityCode` string, required — The facility code associated with the VPS instance. For example:TPA1.
  - `name` string, required — The name of the VPS instance snapshot.
  - `volumeId` string, required — The unique VPS instance volume ID the snapshot is taken of.

## Response `201`

Success

- NetworkTaskDump
  - `clientId` integer — Unique ID of the client triggering the task.
  - `deviceId` integer — Unique ID of the target device.
  - `metaData` string — Key value arguments used to trigger the task.
  - `result` string — Success|Pending|Failed. Null value also means Pending.
  - `taskCreated` object — Timestamp of task creation date.
  - `taskId` string — Unique ID of the network task.
  - `taskUpdated` object — Timestamp of most recent activity taken on the network task. This will update multiple times for multi-step tasks.

## 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/revisions/ee6b717b5015/schema)