Sign in

v1

latestOpenAPI 3.1.02026-07-175096.6 KB
Desktop

Get details of a specific desktop instance

Returns the ID, status, creation timestamp, and timeout timestamp for a given desktop instance.

get/v1/desktop/{id}

Path parameters

idstring uuid required

The UUID of the desktop instance to retrieve

Example:a1b2c3d4-e5f6-7890-1234-567890abcdef

Headers

x-api-keystring required

API key for authentication

Example:api_12345

Response

Desktop instance details retrieved successfully

idstring uuid required

Unique identifier for the desktop instance

status'pending' | 'running' | 'terminated' | 'error' required

Current status of the desktop instance

stream_urlstring nullable required

URL for the desktop stream (null if the desktop is not running)

created_atstring date-time required

Timestamp when the instance was created

timeout_atstring date-time required

Timestamp when the instance will automatically time out

Example response

{
  "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "running",
  "stream_url": "https://cyberdesk.com/vnc/a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "created_at": "2023-10-27T10:00:00Z",
  "timeout_at": "2023-10-28T10:00:00Z"
}
All 5 operations