Sign in
Instances

Get instances

Return all instances of the project, optionally filtered by status and/or tags.

Tag filters: tag=key matches instances carrying the key with any value, tag=key=value matches the value exactly (split at the first =). Repeat the parameter to require multiple tags at once.

Rate limits

This endpoint is rate limited to 120 requests per minute per project.

get/v1/instances

Query parameters

status'running' | 'provisioning' | 'offline' | 'discontinued' | 'unknown' | 'ordered' | 'notfound' | 'new' | 'error' | 'deleting' | 'validating' | 'no_capacity' | 'installation_failed'

Get compute deployments with selected status. Optional

computeIdstring

Get one compute by computeId. Optional

tagstring[]

Return only deployments carrying every listed tag: key matches any value, key=value matches the value exactly (split at the first =). Repeat the parameter to require multiple tags.

[
  "environment=production",
  "benchmark"
]

Response

Instance or a list of instances

idstring required
ipstring nullable required

Public address; null when the instance is not reachable from the internet

private_ipstring nullable required

Private (VPC) address; null when the instance is not on a private network

status'running' | 'provisioning' | 'offline' | 'discontinued' | 'unknown' | 'ordered' | 'notfound' | 'new' | 'error' | 'deleting' | 'validating' | 'no_capacity' | 'installation_failed' required
created_atstring required
created_by_user_idstring
cpuobject required
gpuobject required
gpu_memoryobject required
memoryobject required
storageobject required
hostnamestring required
descriptionstring required
locationstring required
price_per_hournumber required
is_spotboolean required
instance_typestring required
imagestring required
os_namestring required
startup_script_idstring required
ssh_key_idsstring[] required
os_volume_idstring required
jupyter_tokenstring required
contract'LONG_TERM' | 'PAY_AS_YOU_GO' | 'SPOT' required
pricing'DYNAMIC_PRICE' | 'FIXED_PRICE' required
volume_idsstring[] required

Example response

[
  {
    "id": "9baeb2ac-9db0-4280-b08a-4dc1381d2cdc",
    "ip": "1.2.3.4",
    "private_ip": "10.0.0.5",
    "status": "running",
    "created_at": "2023-07-15T14:10:26.654Z",
    "created_by_user_id": "7dfc2631-0158-4f74-93f6-6b46dcb90fef",
    "cpu": {
      "description": "176 CPU",
      "number_of_cores": 176,
      "model": "AMD Genoa"
    },
    "gpu": {
      "description": "8x A100",
      "number_of_gpus": 8
    },
    "gpu_memory": {
      "description": "80GB GPU RAM",
      "size_in_gigabytes": 80
    },
    "memory": {
      "description": "640GB RAM",
      "size_in_gigabytes": 640
    },
    "storage": {
      "description": "dynamic"
    },
    "hostname": "hazy-star-swims-fin-01",
    "description": "ubuntu-22-04-cuda-12-0-docker-fin-01",
    "tags": [
      {
        "id": "tag_0aB1cD2eF3gH4iJ5kL6mN7",
        "key": "environment",
        "value": "production"
      }
    ],
    "location": "FIN-01",
    "price_per_hour": 2.481,
    "instance_type": "8A100.176V",
    "image": "ubuntu-22-04-cuda-12-0-docker",
    "os_name": "Ubuntu 22.04",
    "startup_script_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea",
    "ssh_key_ids": [
      "dd50b622-1c36-48c2-a485-f4d4937a3ea1"
    ],
    "os_volume_id": "95cec4c3-af69-42eb-a790-fcacebfdfcea",
    "jupyter_token": "b9e6d8517db3a722ccfb309ca599a35f",
    "contract": "PAY_AS_YOU_GO",
    "pricing": "FIXED_PRICE",
    "volume_ids": [
      "95cec4c3-af69-42eb-a790-fcacebfdfcea",
      "dd50b622-1c36-48c2-a485-f4d4937a3ea1"
    ]
  }
]

Changes

Changed in 3 of the 10 revisions of this API.13

  • a4749a9b29f21See the full diff
    • ○

      added the new optional query request parameter tag

      new-optional-request-parameter

  • 9894d2c8a6b411See the full diff
    • ▲

      the response property items/ip became nullable for the status 200

      response-property-became-nullable

    • ○

      added the required property items/private_ip to the response with the 200 status

      response-required-property-added

  • c6bc656333bd1See the full diff
    • ○

      added the required property items/tags to the response with the 200 status

      response-required-property-added