Skip to main content
PATCH
/
v1
/
connections
/
{connection_id}
Update Connection
curl --request PATCH \
  --url https://api.cyberdesk.io/v1/connections/{connection_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "websocket_id": "<string>",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ip_address": "<string>",
  "user_agent": "<string>"
}
'
{
  "websocket_id": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connected_at": "2023-11-07T05:31:56Z",
  "disconnected_at": "2023-11-07T05:31:56Z",
  "last_ping": "2023-11-07T05:31:56Z",
  "status": "connected",
  "ip_address": "<string>",
  "user_agent": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Idempotency-Key
string

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Path Parameters

​
connection_id
string<uuid>
required

Body

application/json

Schema for creating a connection

​
websocket_id
string
required
Required string length: 1 - 255
​
machine_id
string<uuid>
required
​
ip_address
string | null
​
user_agent
string | null

Response

Successful Response

Connection response schema

​
websocket_id
string
required
Required string length: 1 - 255
​
id
string<uuid>
required
​
machine_id
string<uuid>
required
​
connected_at
string<date-time>
required
​
disconnected_at
string<date-time> | null
required
​
last_ping
string<date-time>
required
​
status
enum<string>
required
Available options:
connected,
disconnected,
error
​
ip_address
string | null
​
user_agent
string | null