Skip to main content
GET
/
v1
/
machines
List Machines
curl --request GET \
  --url https://api.cyberdesk.io/v1/machines \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unkey_key_id": "<string>",
      "status": "connected",
      "is_available": true,
      "created_at": "2023-11-07T05:31:56Z",
      "last_seen": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "version": "<string>",
      "hostname": "<string>",
      "os_info": "<string>",
      "machine_parameters": {},
      "machine_sensitive_parameters": {},
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "reserved_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "linked_keepalive_machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "physical_server_id": "<string>",
      "pools": [
        {
          "name": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "organization_id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "machine_count": 0
        }
      ]
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123,
  "included": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.cyberdesk.io/llms.txt

Use this file to discover all available pages before exploring further.

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