Pular para o conteúdo principal
GET
Stream events (SSE)

Autorizações

Authorization
string
header
obrigatório

Enforced on every transport, with no exempt operation. A person's request 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 — except a request with no token on a laptop's socket from the OS user the kernel names as the host's own, which is that machine's user.

Cabeçalhos

Last-Event-ID
string

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

Parâmetros de consulta

sessionId
string<uuid>

Only stream events for this session.

hostEvents
boolean
padrão: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.

Resposta

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
obrigatório

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

type
string
obrigatório

The event type, discriminating the payload.

Allowed value: "session-created"
timestamp
string<date-time>
obrigatório
payload
object
obrigatório

A session came into existence.

Exemplo:
sessionId
string<uuid>
laneId
string<uuid>