Sign in

v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB
machines

List Machines

List all machines for the authenticated organization.

Supports pagination and filtering by status, name, or substring search.

Use the include parameter to fetch related resources in the response. Related resources are returned in the included array following the JSON:API pattern.

get/v1/machines

Query parameters

searchstring nullable

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

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

namestring nullable

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.

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'connected' | 'disconnected' | 'error'

Filter by machine status

created_at_fromstring date-time nullable

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

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

created_at_tostring date-time nullable

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

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

includestring nullable

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

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

skipinteger
limitinteger

Response

Successful Response

totalinteger required
skipinteger required
limitinteger required