The API reference is in English.

Current source preview reference

GET /v1/events

Stream events. Permissions, parameters, responses and examples.

0.1.0 · source bccff29 · Immutable snapshot · Download OpenAPI specification

Stream events

Stream events through GET /v1/events. The parameters and declared response shapes below come from this exact source snapshot.

Source preview; no stable third-party integration promise. This page makes no request to a local installation.

Authority

Browser operator session or exact IDE capability with event:read. Route-specific ownership and generation checks also apply.

Inspect the authority source · Authentication guide

Parameters and headers

NameLocationContract
Last-Event-IDheader
Conditional / optional

Last observed event sequence; no query parameters permitted.

Schema
{
  "pattern": "^[0-9]+$",
  "type": "string"
}

Request body

No typed JSON body is declared by this handler. That does not rule out source-level request parsing; inspect the pinned implementation, especially for internal connector protocols.

Responses

StatusMeaning and declared shape
200

Bounded SSE replay and live hints; reconcile REST after reset/disconnect.

text/event-stream · string
{
  "type": "string"
}
400

Exact host, malformed request or URL credential refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
401

Missing or invalid membership

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
403

Exact origin, CSRF or route authority refusal

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
429

Authentication rate or connection limit

application/json · object
{
  "properties": {
    "detail": {
      "type": "string"
    }
  },
  "required": [
    "detail"
  ],
  "type": "object"
}
503

Check readiness and the recorded job state. A healthy control plane does not prove scanner readiness. See source-linked error catalog.

An empty or broad schema preserves the source contract. It is not a promise of an empty response.

Source-linked errors

Literal HTTP errors in this handler and same-file helper call graph, plus control middleware. Dynamic and cross-module failures may add other errors; source links are authoritative.

8 source error observations
StatusSource detailRecovery
400 ↗event stream parameters are forbidden in the URLReview the request shape, exact Host and cursor format. Never put credentials in a URL.
401 ↗authentication requiredReconcile the exact browser or IDE membership through the normal owner workflow.
503 ↗event stream is unavailableCheck readiness and the recorded job state. A healthy control plane does not prove scanner readiness.
429 ↗event stream connection limit reachedRespect bounded capacity and retry after the client backoff. Do not create extra sessions.
503 ↗event stream listener is unavailableCheck readiness and the recorded job state. A healthy control plane does not prove scanner readiness.
401 ↗invalid IDE event-stream authorizationReconcile the exact browser or IDE membership through the normal owner workflow.
400 ↗Last-Event-ID must be a non-negative decimal integerReview the request shape, exact Host and cursor format. Never put credentials in a URL.
400 ↗Last-Event-ID is outside the supported rangeReview the request shape, exact Host and cursor format. Never put credentials in a URL.

Read the recovery guide

Synthetic examples

These examples validate declared JSON shapes and formats. They contain no real installation data and do not prove runtime admission, cross-field validation, authority or successful work.

The source declares no JSON request or successful response schema for this operation. Review the source handler and media type; no response shape has been invented.

Download this service's complete OpenAPI

All referenced models remain in its components section. Browse control model definitions.