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

Authorizations

Authorization
string
header
required

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

Path Parameters

vm_id
string<uuid>
required

VM ID

Response

Get status of a specific VM

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
vm_id
string<uuid>
required