Skip to main content
GET
/
api
/
v1
/
vms
cURL
curl --request GET \
  --url https://api.example.com/api/v1/vms \
  --header 'Authorization: Bearer <token>'
[
  {
    "created_at": "2023-11-07T05:31:56Z",
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vm_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "labels": {}
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

List all VMs accessible to the API key

​
created_at
string<date-time>
required
​
owner_id
string<uuid>
required
​
state
enum<string>
required

The state of a VM

Available options:
booting,
running,
paused,
sleeping,
dead
​
vm_id
string<uuid>
required
​
labels
object