Skip to main content
GET
/
v1
/
machines
/
{machine_id}
Get Machine
curl --request GET \
  --url https://api.cyberdesk.io/v1/machines/{machine_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "unkey_key_id": "<string>",
  "is_available": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_seen": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "<string>",
  "name": "<string>",
  "version": "<string>",
  "hostname": "<string>",
  "os_info": "<string>",
  "machine_parameters": {},
  "machine_sensitive_parameters": {},
  "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
    }
  ],
  "included": [
    {
      "type": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
machine_id
string<uuid>
required

Query Parameters

​
include
string | null

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

Response

Successful Response

Machine response with optional included related resources.

​
id
string<uuid>
required
​
unkey_key_id
string
required
​
status
enum<string>
required
Available options:
connected,
disconnected,
error
​
is_available
boolean
required
​
created_at
string<date-time>
required
​
last_seen
string<date-time>
required
​
user_id
string<uuid> | null
​
organization_id
string | null
​
name
string | null
​
version
string | null
​
hostname
string | null
​
os_info
string | null
​
machine_parameters
Machine Parameters · object
​
machine_sensitive_parameters
Machine Sensitive Parameters · object
​
reserved_session_id
string<uuid> | null
​
linked_keepalive_machine_id
string<uuid> | null
​
physical_server_id
string | null
​
pools
PoolResponse · object[] | null
​
included
IncludedResource · object[] | null

Related resources requested via the include query parameter