List VM Snapshot Restores

GET

/notebooks/{Instance_id}/snapshots/restores/

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

import requests

response = requests.get(
    "https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/{Instance_id}/snapshots/restores/",
    params={"project_id": "<PROJECT_ID>", "location": "<LOCATION>", "apikey": "<API_KEY>"},
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
print(response.json())

const url = new URL("https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/{Instance_id}/snapshots/restores/");
url.search = new URLSearchParams({ project_id: "<PROJECT_ID>", location: "<LOCATION>", apikey: "<API_KEY>" });

const response = await fetch(url, {
  method: "GET",
  headers: { "Authorization": "Bearer <API_TOKEN>" },
});
console.log(await response.json());

Returns the restores made from the Virtual Machine’s snapshots, newest first, each with its progress. Pass page_no and per_page together to page the list.

Parameters

Path Parameters

Instance_id

required

integer

Instance ID

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

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 restores

application/json

object

code

integer

message

string

total_page_number

integer

total_count

integer

data

Array<object>

object

integer

vm_id

integer

snapshot

The snapshot restored from.

integer

snapshot_name

string

nullable

status

restoring, then restored, or failed.

string

Allowed values: restoring restored failed

error

Why the restore failed. Empty when it did not.

string

tier

local for a restore from a snapshot on the cluster.

string

Allowed values: local export

mode

in_place replaces this VM’s disk.

string

Allowed values: in_place to_new_vm

started_at

string

nullable

finished_at

string

nullable

updated_at

string

created_at

string

progress

How far the restore has got. percent_is_measured is false when no figure is available.

object

status

string

stage

restoring, done or failed.

string

percent

integer

message

string

nullable

reason

string

nullable

percent_is_measured

boolean

elapsed_seconds

integer

nullable

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1,
  "data": [
    {
      "id": 35,
      "vm_id": 4984,
      "snapshot": 212,
      "snapshot_name": "before-upgrade",
      "status": "restoring",
      "error": "",
      "tier": "local",
      "mode": "in_place",
      "started_at": "2026-10-21T11:33:02Z",
      "finished_at": "2026-10-21T11:34:20Z",
      "updated_at": "2026-10-21T11:34:20Z",
      "created_at": "2026-10-21T11:33:01Z",
      "progress": {
        "status": "restored",
        "stage": "done",
        "percent": 100,
        "message": null,
        "reason": null,
        "percent_is_measured": true,
        "elapsed_seconds": 78
      }
    }
  ],
  "errors": {}
}

404

No VM with that ID in the project and region.

application/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Invalid Request! Notebook not found"
}