Skip to main content
GET
Python (SDK)

Authorizations

Authorization
string
header
required

Query Parameters

filter[project]
string

The project ID or Slug to filter by

filter[tags]
string

The tag IDs to filter by, separated by comma, e.g. filter[tags]=tag_1,tag_2 will return VMs with tag_1 AND tag_2.

extra_fields[virtual_machines]
string

Comma-separated extra attributes that are lazy-loaded. Supported values: credentials, pending_restart. Example: extra_fields[virtual_machines]=credentials,pending_restart.

sort
string

Comma-separated sort fields. Prefix a field with - for descending order. Supported fields: created_at, name, hostname, status. Example: sort=status,-created_at sorts by status ascending, then by creation date descending.

page[size]
integer
default:20

Number of items to return per page

Required range: x >= 1
page[number]
integer
default:1

Page number to return (starts at 1)

Required range: x >= 1
stats[total]
string

Request aggregate stats in the response meta. Use count to get the total number of records, returned as meta.stats.total.count.

Response

Success

data
object[]
meta
object