GET
/
projects
/
{id}
/
vms
List VMs
curl --request GET \
  --url https://api.mkinf.io/v0.1/projects/{id}/vms \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "b3e571f6-c87d-4135-8081-ab219e92544e",
      "project_id": "3291380a-19e9-4892-a139-2fa92aa740e2",
      "type": "l40s-48gb.1x",
      "state": "STATE_RUNNING",
      "ssh_destination": ":0",
      "created_at": "2024-06-16T15:52:41Z",
      "updated_at": "2024-06-16T15:52:53Z",
      "name": "mkinf-node",
      "location": "us-east1-a",
      "commitment_period": 0,
      "commitment_end": "",
      "disks": [
        {
          "id": "52822513-e425-4be9-8dd8-5c21d561ce11",
          "name": "OS-disk-b3e571f6-c87d-4135-8081-ab219e92544e",
          "type": "persistent-ssd",
          "size": "128GiB",
          "location": "vaeq-cu",
          "block_size": 0,
          "created_at": "2024-06-16T15:52:43Z",
          "updated_at": "2024-06-16T15:52:44Z",
          "serial_number": "B74EEFE8EFA0988490E",
          "attachment_type": "os",
          "mode": "read-write"
        }
      ],
      "network_interfaces": [
        {
          "id": "fdf58fb1-0185-40f2-aa20-b620e8a8562d",
          "name": "default-network-interface",
          "network": "695b751c-2eaa-4e8b-8eb2-84cb367a69fe",
          "subnet": "7ceecd34-2631-4857-ad82-ceb9dfd09425",
          "interface_type": "Ethernet",
          "mac_address": "2e:2f:ae:ef:ae:16",
          "ips": [
            {
              "private_ipv4": {
                "address": "172.27.23.237"
              },
              "public_ipv4": {
                "address": "204.52.24.84",
                "id": "e130674a-c05e-4345-b8a4-7928c6649574",
                "type": "dynamic"
              }
            }
          ]
        }
      ],
      "host_channel_adapters": [],
      "virtualization_features": {
        "nested_virtualization": false
      },
      "instance_template_id": "",
      "instance_group_id": "",
      "reservation_id": ""
    }
  ],
  "next_page_token": "",
  "prev_page_token": ""
}
List all VM instances in a project. Supports filtering by various parameters.

​
Query Parameters

  • ids: Filter by specific VM IDs
  • names: Filter by VM names
  • types: Filter by VM types
  • locations: Filter by locations
  • states: Filter by VM states
  • limit: Maximum number of results
  • sort: Sort field
  • next_token: Token for next page
  • prev_token: Token for previous page

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Project id

Query Parameters

​
ids
string[]

VM ids

​
names
string[]

VM names

​
types
string[]

VM types

​
locations
string[]

Locations

​
states
string[]

VM status

​
limit
string

Limit

​
sort
string

Sort

​
next_token
string

Next page

​
prev_token
string

Prev page

Response

200 - application/json

The response is of type object.