Skip to main content
GET
/
api
/
v0
/
instances
/
{id}
/
show instance
curl --request GET \
  --url https://console.vast.ai/api/v0/instances/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "instances": {
    "id": 123,
    "ssh_idx": "ssh1",
    "ssh_host": "192.168.1.10",
    "ssh_port": 22,
    "actual_status": "running",
    "intended_status": "running",
    "cur_state": "running",
    "next_state": "running",
    "template_id": 45,
    "template_hash_id": "abc123",
    "image_uuid": "uuid-1234",
    "image_args": "--arg1 value",
    "image_runtype": "ssh",
    "extra_env": [
      "VAR1=value1",
      "VAR2=value2"
    ],
    "onstart": "init.sh",
    "label": "Instance 123",
    "jupyter_token": "token123",
    "status_msg": "Running normally",
    "gpu_util": 0.75,
    "gpu_arch": "Volta",
    "disk_util": 75,
    "disk_usage": 75,
    "gpu_temp": 65,
    "cuda_max_good": 11.2,
    "driver_version": "460.32.03",
    "public_ipaddr": "203.0.113.1",
    "local_ipaddrs": [
      "192.168.1.5"
    ],
    "direct_port_end": 8001,
    "direct_port_start": 8000,
    "cpu_util": 0.65,
    "mem_usage": 4096,
    "mem_limit": 8192,
    "vmem_usage": 4096,
    "machine_dir_ssh_port": 2222,
    "uptime_mins": 120,
    "ports": [
      8080,
      8081
    ]
  }
}

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Path Parameters

id
integer
required

The ID of the instance to retrieve.

Response

Success response with instance details.

instances
object

Detailed information about an instance.

I