v1

latestSwagger 2.02026-08-04232286653.5 KB

VMs

Lists all VMs in the project and returns their details.

get/projects/{project_id}/compute/vms/instances

Path parameters

project_idstring required

Query parameters

idsstring

Filters results to VMs with these IDs.

namesstring

Filters results to VMs with these names.

typesstring

Filters results to VMs of these types.

locationsstring

Filters results to VMs in these locations.

statesstring

Filters results to VMs in these states.

nvlink_domain_idsstring

Filters results to VMs in these NVLink domains.

limitstring

Maximum number of VMs to return per page.

sortstring

Field to sort the results by.

next_tokenstring

Token identifying the next page of results to return.

prev_tokenstring

Token identifying the previous page of results to return.

Response

next_page_tokenstring

Base64 encoded token representing the next page of instances. Empty if currently on the last page.

prev_page_tokenstring

Base64 encoded token representing the previous page of instances. Empty if currently on the first page.

Example response

{
  "items": [
    {
      "created_at": "2021-12-03T19:58:34Z",
      "disks": [
        {
          "attachment_type": "os | data",
          "block_size": 4096,
          "created_at": "2021-12-03T19:58:34Z",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "location": "us-northcentral1-a",
          "mode": "read-write | read-only",
          "name": "my-disk",
          "serial_number": "96FD14FDBCF7E21E8EC",
          "size": "10GiB",
          "type": "persistent-ssd",
          "updated_at": "2021-12-03T19:58:34Z"
        }
      ],
      "host_channel_adapters": [
        {
          "guid": "946d:ae03:0021:69aa",
          "transport_network_id": "ca39e669-47ee-456b-968d-303234fbf99f",
          "transport_partition_id": "ca39e669-47ee-456b-968d-303234fbf99f",
          "type": "infiniband"
        }
      ],
      "id": "ca39e669-47ee-456b-968d-303234fbf99f",
      "instance_group_id": "707749bd-ecad-4de8-aa00-1ae2fdb99e19",
      "instance_template_id": "75c6712a-8da8-463c-a72d-fc65cf922959",
      "location": "us-centralnorth1-a",
      "name": "my-first-vm",
      "network_interfaces": [
        {
          "id": "ca39e669-47ee-456b-968d-303234fbf99f",
          "interface_type": "ethernet",
          "ips": [
            {
              "private_ipv4": {
                "address": "10.1.2.3"
              },
              "public_ipv4": {
                "address": "121.0.0.0",
                "id": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
                "type": "dynamic"
              }
            }
          ],
          "mac_address": "00:00:5e:00:53:af",
          "name": "network-interface-1",
          "network": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc",
          "subnet": "1ce839b7-3fab-46f9-8e54-7a6bb4ac1ffc"
        }
      ],
      "pod_id": "29d20dc4-90ad-4365-ab05-83f5f5e52d94",
      "project_id": "09ae8411-0fbb-411c-898c-2b8f19622ae1",
      "reservation_id": "804bf3a2-81f2-4d78-9a9e-dc6a55ed33d8",
      "state": "RUNNING",
      "type": "a100.2x",
      "updated_at": "2023-08-14T09:00:35Z",
      "virtualization_features": {
        "nested_virtualization": true
      }
    }
  ],
  "next_page_token": "bXktbGFzdC12bQ",
  "prev_page_token": "bXktZmlyc3Qtdm0"
}