CYcyberdesk-hq
machines

Get Machine

Get a specific machine by ID.

The machine must belong to the authenticated organization.

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/{machine_id}

Request

  • Base URL
    https://api.cyberdesk.io
  • URL
    https://api.cyberdesk.io/v1/machines/{machine_id}
  • Auth
    HTTP bearer

Path parameters

machine_idstring uuid required

Query parameters

includestring nullable

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

Response

Successful Response

idstring uuid required
user_idstring uuid nullable
organization_idstring nullable
namestring nullable
unkey_key_idstring required
versionstring nullable
hostnamestring nullable
os_infostring nullable
machine_parametersobject nullable
machine_sensitive_parametersobject nullable
status'connected' | 'disconnected' | 'error' required
is_availableboolean required
alerts_enabledboolean required
reserved_session_idstring uuid nullable
linked_keepalive_machine_idstring uuid nullable
physical_server_idstring nullable
created_atstring date-time required
last_seenstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.