List Project VM Snapshots

GET

/notebooks/vm/snapshots/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/vm/snapshots/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns the snapshots of every Virtual Machine in the project and region, newest first, including those of VMs that have since been deleted. Each snapshot also lists the VMs launched from it in launched_vms. A bare call also returns copies kept in object storage, with tier set to export; pass tier=local for the snapshots on the cluster only. Pass page_no and per_page together to page the list.

Parameters

Query Parameters

project_id

required

integer

Project ID

page_no

integer

The page number from which you want your page search results to be displayed.

per_page

integer

Number of results per page

tier

string

Allowed values: local export

local for snapshots on the cluster, export for copies in object storage. Other values are ignored.

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The snapshots

Media typeapplication/json

object

code

integer

message

string

total_page_number

integer

total_count

integer

data

Array<object>

object

id

integer

vm_id

ID of the VM the snapshot was taken from.

integer

vm_name

Name of that VM when the snapshot was taken.

string

nullable

vm_deleted

true once the VM has been deleted. The snapshot stays.

boolean

name

The snapshot’s name.

string

nullable

status

pending while the snapshot is being made, then ready, or failed.

string

Allowed values: pending ready failed

ready

true when the snapshot can be restored or launched from.

boolean

snapshot_type

manual for one you took, scheduled for one the schedule took.

string

Allowed values: manual scheduled

consistency

filesystem when the VM’s guest agent answered while the snapshot was taken, crash otherwise.

string

Allowed values: filesystem crash

consistency_reason

Why the snapshot has its consistency: quiesced, vm_stopped or guest_agent_unavailable.

string

size_gb

Size of the disk the snapshot was taken from, in GB.

number

nullable

size_bytes

Size of the disk the snapshot was taken from, in bytes.

integer

nullable

stored_bytes

Storage the snapshot uses, in bytes. null until it is measured.

integer

nullable

taken_at

When the snapshot was taken. null until it is ready.

string

nullable

failed_at

When the snapshot failed, if it did.

string

nullable

created_at

string

image_details

The image and version of the source VM. null when none is recorded.

object

image_id

integer

version_id

integer

name

string

version

string

snapshot_scope

What the snapshot covers.

string

Allowed values: vm disk

tier

local for a snapshot on the cluster, export for a copy in object storage.

string

Allowed values: local export

created_by

Who took the snapshot.

object

id

integer

name

string

email

string

username

string

progress

How far the snapshot has got. Always present.

object

status

string

stage

string

message

string

nullable

percent

integer

eta_seconds

integer

nullable

elapsed_seconds

integer

nullable

reason

Why the snapshot failed, if it did.

string

nullable

percent_is_measured

boolean

is_delayed

boolean

progress_steps

Array<object>

object

key

string

label

string

status

string

Allowed values: done running pending failed

launched_vms

VMs launched from this snapshot, deleted ones included.

Array<object>

object

id

integer

name

string

status

The VM’s status.

string

deleted

boolean

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1,
  "data": [
    {
      "id": 212,
      "vm_id": 4984,
      "vm_name": "web-01",
      "vm_deleted": false,
      "name": "before-upgrade",
      "status": "pending",
      "ready": true,
      "snapshot_type": "manual",
      "consistency": "filesystem",
      "consistency_reason": "quiesced",
      "size_gb": 30,
      "size_bytes": 32212254720,
      "stored_bytes": 1580000000,
      "taken_at": "2026-10-21T11:17:42Z",
      "failed_at": null,
      "created_at": "2026-10-21T11:17:29Z",
      "image_details": {
        "image_id": 14,
        "version_id": 16,
        "name": "Ubuntu",
        "version": "24.04"
      },
      "snapshot_scope": "vm",
      "tier": "local",
      "created_by": {
        "id": 1,
        "name": "A User",
        "email": "user@example.com",
        "username": "auser"
      },
      "progress": {
        "status": "ready",
        "stage": "ready",
        "message": null,
        "percent": 100,
        "eta_seconds": null,
        "elapsed_seconds": 12,
        "reason": null,
        "percent_is_measured": true,
        "is_delayed": false,
        "progress_steps": [
          {
            "key": "cutting",
            "label": "Taking the snapshot",
            "status": "done"
          }
        ]
      },
      "launched_vms": [
        {
          "id": 5010,
          "name": "web-02",
          "status": "Running",
          "deleted": false
        }
      ]
    }
  ],
  "errors": {}
}