Instance / VM List

GET

/notebooks/

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

Returns a paginated list of compute resources in the project.

Use the kind query parameter to filter by compute type: pass kind=vm to return only Virtual Machines, or kind=container to return only container-based Instances. You must also pass is_advanced_search=true for the kind filter to take effect — without it, the filter is ignored and all resources are returned.

Parameters

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

kind

string

Allowed values: vm container

Filter results by compute type. Pass kind=vm to return only Virtual Machines, or kind=container to return only container-based Instances.

Important: This filter only takes effect when is_advanced_search=true is also passed. Without it, the kind parameter is ignored and all resources are returned.

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

order_by

string

Allowed values: notebook

is_advanced_search

boolean

Specifies if advanced filters should be applied.

instance_category

required

string

Allowed values: notebook

name

string

Filter by name. Requires is_advanced_search=true to take effect.

status

string

Allowed values: ready waiting terminating error Pending stopped

Filter by resource status. Requires is_advanced_search=true to take effect.

custom

string

Allowed values: custom pre-built

Filter by image type. Requires is_advanced_search=true to take effect.

sku series

string

Allowed values: CPU GPU

Filter by SKU series. Requires is_advanced_search=true to take effect.

sku_type

string

Allowed values: hourly committed

Filter by SKU type. Requires is_advanced_search=true to take effect.

Responses

200

Successful response with node details

Media typeapplication/json

object

code

integer

message

string

total_page_number

integer

total_count

integer

data

Array<object>

object

id

integer

name

string

project_id

integer

image_type

string

image_details

object

image_id

integer

version_id

integer

name

string

icon_url

string

image_description

string

version_description

string

sku_details

object

specs

object

sku_id

integer

name

string

series

string

cpu

integer

gpu

integer

memory

integer

is_free

boolean

is_active

boolean

gpu_switch_type

string

nullable

local_storage_in_gb

integer

plan

object

sku_item_price_id

integer

sku_type

string

committed_days

integer

unit_price

number format: float

currency

string

is_active

boolean

description

string

nullable

status

string

last_activity

string format: date-time

created_by

object

id

integer

name

string

email

string

username

string

created_at

string format: date-time

updated_at

string format: date-time

lab_url

string

disk_size_in_gb

integer

instance_type

string

ssh_keys

Array<string>

disable_ssh_login_password

boolean

public_ip

string

e2e_registry_image_url

string

nullable

egress_gateway_ip

string

add_ons

object

key

additional properties

any

is_jupyterlab_enabled

boolean

is_ssh_enabled

boolean

custom_ports

Array<string>

private_cloud_id

string

nullable

custom_sku

string

nullable

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "total_page_number": 1,
  "total_count": 1,
  "data": [
    {
      "id": 4984,
      "name": "node-09161505088",
      "project_id": 124,
      "image_type": "pre-built",
      "image_details": {
        "image_id": 14,
        "version_id": 16,
        "name": "Ubuntu",
        "icon_url": "/notebook_images/ubuntu.svg",
        "image_description": "Ubuntu 22.04 base image with Python 3.10",
        "version_description": "Ubuntu 22.04 base image with Python 3.10"
      },
      "sku_details": {
        "specs": {
          "sku_id": 4,
          "name": "C3.8GB",
          "series": "CPU",
          "cpu": 4,
          "gpu": 0,
          "memory": 8,
          "is_free": false,
          "is_active": true,
          "gpu_switch_type": null,
          "local_storage_in_gb": 0
        },
        "plan": {
          "sku_item_price_id": 4,
          "sku_type": "hourly",
          "committed_days": 0,
          "unit_price": 3.1,
          "currency": "INR",
          "is_active": true,
          "description": null
        }
      },
      "status": "ready",
      "last_activity": "2024-09-16T09:35:18Z",
      "created_by": {
        "id": 3573,
        "name": "Nipun",
        "email": "nipun.arora@e2enetworks.com",
        "username": "nipun.arora@e2enetworks.com"
      },
      "created_at": "2024-09-16T09:35:18.580926Z",
      "updated_at": "2024-11-13T10:58:41.184577Z",
      "lab_url": "https://notebooks.e2enetworks.com/notebook/p-124/n-7e940564-90f0-4e55-94f0-f67891aa0b68/lab",
      "disk_size_in_gb": 30,
      "instance_type": "paid_usage",
      "ssh_keys": [],
      "disable_ssh_login_password": true,
      "public_ip": "",
      "e2e_registry_image_url": null,
      "egress_gateway_ip": "116.204.174.167",
      "add_ons": {},
      "is_jupyterlab_enabled": true,
      "is_ssh_enabled": false,
      "custom_ports": [],
      "private_cloud_id": null,
      "custom_sku": null
    }
  ],
  "errors": {}
}