Skip to main content
GET
Stream events (SSE)

Authorizations

Authorization
string
header
required

Enforced on every transport, with no exempt operation. A person's request — over the default local unix socket exactly as over a TCP listener — must carry a JWT issued by the configured identity provider, which the host verifies itself against that issuer's key set: signature, issuer, expiry, and the person and organisation it names. Requests without a valid one receive 401 NRY-0011. The socket's file permissions are transport and are not an authorisation.

Headers

Last-Event-ID
string

Resume the stream from the first event after this id, as defined by the SSE specification.

Query Parameters

sessionId
string<uuid>

Only stream events for this session.

hostEvents
boolean
default:false

When sessionId narrows the stream, also deliver the events that belong to no session at all — things true of the whole machine, like an installed package's files changing under everybody (ladder-changed). Off by default, so an existing consumer's stream is unchanged. Ignored without sessionId, where the unfiltered firehose already carries them.

Response

An open server-sent event stream. Each frame's data field is one Event envelope.

The typed event envelope carried in each SSE frame's data field, discriminated by type.

id
string
required

Monotonic per-stream event id, usable as Last-Event-ID.

type
string
required

The event type, discriminating the payload.

Allowed value: "session-created"
timestamp
string<date-time>
required
payload
object
required

A session came into existence.

Example:
sessionId
string<uuid>
laneId
string<uuid>