Get VM Snapshot Schedule

GET

/notebooks/{Instance_id}/snapshots/schedule/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/{Instance_id}/snapshots/schedule/?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/schedule/",
    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/schedule/");
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 automatic snapshot schedule of the Virtual Machine. A VM that never had one set up returns automatic snapshots off with the default schedule, every 6 hours, keeping 7.

Parameters

Path Parameters

Instance_id

required

integer

Instance ID

Query Parameters

project_id

required

integer

Project ID

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 schedule

application/json

object

code

integer

message

string

data

object

snapshot_enabled

true when automatic snapshots are on.

boolean

snapshot_schedule_cron

The schedule, as a five-field cron expression in India time (IST).

string

snapshot_retention_count

How many scheduled snapshots to keep, from 1 to 60.

integer

snapshot_last_run_at

When the schedule last took a snapshot.

string

nullable

snapshot_next_run_at

When it takes the next one. null when automatic snapshots are off.

string

nullable

policy

The stored schedule record: id, vm_id, enabled, schedule_cron, retention_count, last_run_at, status, location, created_at, updated_at. null for a VM that never had a schedule.

object

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "snapshot_enabled": true,
    "snapshot_schedule_cron": "0 */6 * * *",
    "snapshot_retention_count": 7,
    "snapshot_last_run_at": null,
    "snapshot_next_run_at": "2026-10-21T12:30:00Z",
    "policy": null
  },
  "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"
}