Skip to main content
GET
List VMs

Authorizations

Authorization
string
header
required

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

Query Parameters

team_id
string

Team ID that need to be considered for filter. Default team will be used if not provided.

Response

Successful operation

id
string<uuid>
Example:

"c1d45377-b2a9-4407-ab8d-6909c34dfaac"

name
string<string>
Example:

"ubuntu-vm-4vcpu-8gb"

password
string

The server's auto-generated administrator/root password.

Example:

"s3cr3t-p4ssw0rd"

vcpu
integer<int64>
Example:

2

ram
integer<int64>
Example:

4096

disk
integer<int64>
Example:

40

bw_used
number<float>
Example:

12.5

main_ipv4
string<string>
Example:

"160.22.79.122"

main_ipv6
string<string>
Example:

"2401:a4a0:1:90::1"

template
string<string>
Example:

"Ubuntu 24.04 x64 LTS"

firewall_group_id
string<uuid> | null
Example:

"ac135def-c613-4a08-fd8e-a20acbdd23a9"

created_at
string<datetime>
Example:

"2024-10-04T10:20:22.922772Z"

renewed_at
string<datetime>
Example:

"2024-10-04T10:20:22.922772Z"

due_date
string<datetime>
Example:

"2024-10-04T10:20:22.922772Z"

recurring_amount
number<float>
Example:

5.5

amount_paid
number<float>
Example:

1.2345

payment_currency
string<string>
Example:

"AUD"

billing_cycle
integer<int64>
Example:

1

status
enum<string>
Available options:
building,
active,
suspended,
awaiting_payment,
taking_snaphot,
restoring,
terminating,
migrating