Skip to main content
PATCH
Update Connection

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 updating a connection

status
enum<string> | null
Available options:
connected,
disconnected,
error
last_ping
string<date-time> | null
disconnected_at
string<date-time> | 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