Skip to main content
POST
Arm / refresh the dead-man switch

Authorizations

DX-ACCESS-KEY
string
header
required

The public API key (alphanumeric access_key string).

DX-ACCESS-TIMESTAMP
string
header
required

Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.

DX-ACCESS-SIGNATURE
string
header
required

base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.

Body

application/json

Arm / refresh the dead-man switch.

timeout_ms
integer
required

Heartbeat budget in milliseconds. On the first tick at or after now + timeout_ms the gateway fires one user-wide MASS_CANCEL and disarms (fire-once). Re-arm to refresh the deadline.

Required range: 1000 <= x <= 60000

Response

Dead-man armed / refreshed.

The armed dead-man state.

timeout_ms
integer
required
Required range: 1000 <= x <= 60000
armed
enum<boolean>
required
Available options:
true