v12

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

List snapshots

List snapshots for the authenticated account. Filter by VM, volume, or type.

Pass X-Project-ID to scope the list to a single project. When omitted, returns snapshots across every project the API key has access to.

get/api/v1/snapshots

Query parameters

vm_idstring uuid

Filter by VM UUID

volume_idinteger

Filter by volume ID

type'vm' | 'volume'

Filter by snapshot type (vm or volume)

limitinteger
offsetinteger

Headers

X-Project-IDstring uuid

Optional project ID to scope the list. Omit to list across all accessible projects.

Response

List of snapshots

successboolean
totalinteger

Example response

{
  "data": [
    {
      "status": "active"
    }
  ]
}