List VMs
GET
/vmsList all the VM instances you have access to
Request
Query Params
ids
array[string]
optional
VM ids
Example:
["ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab"]
names
array[string]
optional
VM names
Example:
["my-vm"]
types
array[string]
optional
VM types
Example:
["a40.2x","a100.8x"]
locations
array[string]
optional
Locations
Example:
["us-east1","us-northcentral1"]
states
array[string]
optional
VM status
Example:
["RUNNING"]
limit
string
optional
Limit
Example:
20
sort
string
optional
Sort
Example:
name
next_token
string
optional
Next page
Example:
bXktZmlyc3Qtdm0
prev_token
string
optional
Prev page
Example:
bXktZmlyc3Qtdm0
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
items
array [object {18}]
required
id
string
optional
project_id
string
optional
type
string
optional
state
string
optional
ssh_destination
string
optional
created_at
string
optional
updated_at
string
optional
name
string
optional
location
string
optional
commitment_period
integer
optional
commitment_end
string
optional
disks
array [object {11}]
optional
network_interfaces
array [object {7}]
optional
host_channel_adapters
array[string]
optional
virtualization_features
object
optional
instance_template_id
string
optional
instance_group_id
string
optional
reservation_id
string
optional
next_page_token
string
required
prev_page_token
string
required
Example
{
"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": ""
}
Modified at 2 months ago