Sign in
General APIs with JWT

Current snapshot of the rentable executors (WebSocket address)

Returns the same snapshot frame a WebSocket client receives first, for a caller that wants the set once and does not want to hold a connection.

The same address serves a WebSocket at wss://lium.io/api/executors/ws. Connect to it to stay current: the socket opens with this snapshot and then sends upsert, delete and heartbeat frames. OpenAPI cannot describe a WebSocket, which is why it is named here.

No authentication. 503 means the publisher has not completed its first read yet — retry.

get/executors/ws

Response

Successful Response

type'snapshot' required
schema_versioninteger required

Protocol version of the envelope. The current version is 1.

seqinteger required

Sequence number of the last published frame. It orders frames within one WebSocket connection and carries no meaning across connections or replicas.

tsnumber required

Server publish time of this snapshot, as Unix seconds.

executorsobject[] required

Every executor that is rentable right now, as an availability projection. The example below carries the complete card: the field set is fixed, and a value is null rather than absent when it is unknown.

Changes