List Cloud VM snapshots in the workspace

GET

/compute/cloud-vm-snapshots

GET

/v1/compute/cloud-vm-snapshots

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/compute/cloud-vm-snapshots?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

{
  "snapshots": [
    {
      "organization_id": "<organization_id>",
      "workspace_id": "<workspace_id>",
      "snapshot_set_id": "<snapshot_set_id>",
      "vm_id": "<vm_id>",
      "name": "<name>",
      "recovery_point_id": "<recovery_point_id>",
      "status": "queued",
      "created_at": "2026-10-25T12:00:00Z",
      "updated_at": "2026-10-25T12:00:00Z",
      "organization_name": "<organization_name>",
      "workspace_name": "<workspace_name>",
      "vm_name": "<vm_name>",
      "vm_type": "cloud",
      "description": "<description>",
      "recovery_point_type": "snapshot",
      "capture_scope": "root_only",
      "captured_volume_count": 1,
      "root_only": true,
      "size_gb": 1,
      "source_disk_size_gb": 1,
      "display_size_gb": 1,
      "display_storage_bytes": 1,
      "backend_protected_storage_bytes": 1,
      "protected_storage_bytes": 1,
      "billing_storage_bytes": 1,
      "billing_storage_source": "unavailable",
      "metering_status": "unavailable",
      "storage_backend": "<storage_backend>",
      "captured_topology_hash": "<captured_topology_hash>",
      "root_volume_id": "<root_volume_id>",
      "root_volume_name": "<root_volume_name>",
      "volume_manifest": [],
      "volume_manifest_summary": {
        "root_only": true,
        "root_volume_name": "<root_volume_name>",
        "data_volume_names": [],
        "summary_text": "Root"
      },
      "live_drift_summary": {
        "drifted": false,
        "missing_from_live": [],
        "new_live_only": [],
        "message": "<message>"
      },
      "metadata": {}
    }
  ],
  "total": 0
}

Lists snapshot sets of every Cloud VM in the workspace, as the portal’s Snapshots page does. Requires scope: vm.read.

# Example request with curl (set IBEE_API_TOKEN to a platform API token and WORKSPACE_ID to the workspace first).
curl "https://api.ibee.ai/v1/compute/cloud-vm-snapshots?workspace_id=$WORKSPACE_ID" \
  -H "Authorization: Bearer $IBEE_API_TOKEN"

Authentication

AuthorizationBearer

IBEE platform API token. Production tokens start with ibee_prod_key_; development tokens start with ibee_dev_key_. Use a token only with its matching gateway environment.

Query parameters

workspace_idstringRequiredformat: "^[1-9][0-9]*$">=1 character

The positive numeric workspace ID to scope this request to. Zero, negative, and non-numeric values are rejected.

limitintegerOptional1-500Defaults to 100

Maximum number of snapshot sets to return (1-500). Default 100.

offsetintegerOptional>=0Defaults to 0

Number of items to skip before the first returned item. Default 0.

searchstringOptional>=1 character

Return only snapshot sets whose fields contain this text.

Response

Snapshot sets returned successfully.

snapshotslist of objects

Snapshot sets on this page.

totalintegerDefaults to 0

Total number of snapshot sets matching the request.

Errors

401

Unauthorized Error

403

Forbidden Error

503

Service Unavailable Error