Server-Sent Events stream for the web UI

GET

/api/v1/events

curl --request GET \
  --url https://example.com/api/v1/events \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>'

text/event-stream with JSON frames {channel, printer_id, type, ts, data}. Without printer_id it carries every printer the caller may see plus the hub channel (hub.printers_changed) and the sheets channel (sheet.updated). An API key without admin scope gets job.state_changed and run.state_changed (live and in the snapshot) only for the jobs and tape runs it submitted. Ends with auth.expired when the session or key stops being valid. Returns 404 for an unknown printer_id, 403 when the credentials exclude it, 429 when LABELYARD_SSE_MAX_SUBSCRIBERS connections are open.

Authorizations

• APIKeyHeader

Parameters

Query Parameters

printer_id

Printer Id

Any of:

string

string format: uuid

null

null

Responses

200

Successful Response

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}