v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB

connections

Update Connection

Update a connection's status or timestamps.

Only the fields provided in the request body will be updated. The connection must belong to a machine owned by the authenticated organization.

patch/v1/connections/{connection_id}

Path parameters

connection_idstring uuid required

Headers

Idempotency-Keystring

Example:550e8400-e29b-41d4-a716-446655440000

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.

Request body

status'connected' | 'disconnected' | 'error'

last_pingstring date-time nullable

disconnected_atstring date-time nullable

Response

Successful Response

websocket_idstring required

ip_addressstring nullable

user_agentstring nullable

idstring uuid required

machine_idstring uuid required

connected_atstring date-time required

disconnected_atstring date-time nullable required

last_pingstring date-time required

status'connected' | 'disconnected' | 'error' required