Sign in

v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Snapshots

Create snapshot

Create a snapshot of a VM or a volume.

  • For a VM snapshot, set resource_type to vm and pass the VM UUID as resource_id.
  • For a volume snapshot, set resource_type to volume and pass the integer volume_id.
post/api/v1/snapshots

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Request body

resource_type'vm' | 'volume' required

Source type for the snapshot

resource_idstring uuid

Source VM UUID. Required when resource_type is vm.

volume_idinteger

Source volume ID. Required when resource_type is volume.

namestring required

Snapshot display name

Example request

{
  "name": "pre-upgrade"
}

Response

Snapshot created

successboolean

Example response

{
  "data": {
    "status": "active"
  }
}