v1

latestOpenAPI 3.1.02026-07-22136108233.0 KB

connections

Create Connection

Create a new connection (typically done by the WebSocket handler).

The machine must exist and belong to the authenticated organization.

post/v1/connections

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

websocket_idstring required

ip_addressstring nullable

user_agentstring nullable

machine_idstring uuid required

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