Get Instance / VM Details — API

Path parameters

Instance_idPathintegerrequired
Instance ID

Query parameters

project_idQueryintegerrequired
Project ID
active_iamQueryintegeroptional
Active IAM ID (To access contact person account) Find your Active IAM ID here
locationQuerystringrequired
Location

Responses

200Full details of an Instance or Virtual Machine

object

codeinteger

example200

dataobject

404Instance or VM not found

object

codeinteger

example404

messagestring

exampleNot found

Request

curl -X GET 'https://api.e2enetworks.com/myaccount/api/v1/gpu/notebooks/{Instance_id}/?project_id=%3Cproject_id%3E&active_iam=%3Cactive_iam%3E&location=%3Clocation%3E&apikey=%3Capikey%3E' \
  -H 'Authorization: Bearer <JWT>'

Response · 200

{
  "code": 200,
  "data": {
    "id": 5633,
    "name": "my-gpu-vm",
    "kind": "vm",
    "status": "running",
    "public_ip": "203.0.113.42",
    "image_type": "pre-built",
    "image_details": {
      "name": "Ubuntu",
      "icon_url": "/notebook_images/ubuntu.svg",
      "image_description": "Ubuntu 22.04 base image with Python 3.10"
    },
    "sku_details": {
      "specs": {
        "name": "GDC.1xH100-SXM5-80GB",
        "cpu": 26,
        "gpu": 1,
        "memory": "240GB"
      }
    },
    "disk_size_in_gb": 100,
    "instance_type": "paid_usage",
    "ssh_keys": [
      {
        "id": 12,
        "name": "my-laptop-key"
      }
    ],
    "security_groups": [
      {
        "id": 45,
        "name": "allow-ssh"
      }
    ],
    "init_scripts": [
      {
        "id": 8,
        "name": "01_install.sh"
      }
    ],
    "reserve_ip": [
      {
        "id": 99,
        "ip_address": "203.0.113.42"
      }
    ],
    "custom_ports": [
      {
        "protocol": "TCP",
        "port": 8888
      }
    ],
    "is_pvc_encrypted": false,
    "created_at": "2025-04-10T08:30:00Z",
    "updated_at": "2025-04-10T09:00:00Z"
  }
}