Skip to main content
GET
List Machines

Authorizations

Authorization
string
header
required

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

Query Parameters

search
string | null

Search machines by id, name, or hostname (case-insensitive substring match)

name
string | null

Exact-match filter on the machine's name (case-sensitive). Use this to look up machines by the value passed to cyberdriver --name, e.g. when correlating VMs you spawned from the same image. Names are not unique; the response is a list.

status
enum<string> | null

Filter by machine status

Available options:
connected,
disconnected,
error
created_at_from
string<date-time> | null

Filter machines created at or after this ISO timestamp (UTC)

created_at_to
string<date-time> | null

Filter machines created at or before this ISO timestamp (UTC)

include
string | null

Comma-separated list of related resources to include. Allowed values: pools. Example: include=pools

skip
integer
default:0
Required range: x >= 0
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

items
MachineResponse · object[]
required
total
integer
required
skip
integer
required
limit
integer
required
included
IncludedResource · object[] | null

Related resources requested via the include query parameter