Current source preview reference
GET /v1/events
Stream events. Permissions, parameters, responses and examples.
Read pinned handler: apps/api/kodesec_api/events.py:1260
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.
Parameters and headers
| Name | Location | Contract |
|---|---|---|
Last-Event-ID | header Conditional / optional | Last observed event sequence; no query parameters permitted. Schema |
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
| Status | Meaning and declared shape |
|---|---|
200 | Bounded SSE replay and live hints; reconcile REST after reset/disconnect. text/event-stream · string |
400 | Exact host, malformed request or URL credential refusal application/json · object |
401 | Missing or invalid membership application/json · object |
403 | Exact origin, CSRF or route authority refusal application/json · object |
429 | Authentication rate or connection limit application/json · 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
| Status | Source detail | Recovery |
|---|---|---|
| 400 ↗ | event stream parameters are forbidden in the URL | Review the request shape, exact Host and cursor format. Never put credentials in a URL. |
| 401 ↗ | authentication required | Reconcile the exact browser or IDE membership through the normal owner workflow. |
| 503 ↗ | event stream is unavailable | Check readiness and the recorded job state. A healthy control plane does not prove scanner readiness. |
| 429 ↗ | event stream connection limit reached | Respect bounded capacity and retry after the client backoff. Do not create extra sessions. |
| 503 ↗ | event stream listener is unavailable | Check readiness and the recorded job state. A healthy control plane does not prove scanner readiness. |
| 401 ↗ | invalid IDE event-stream authorization | Reconcile the exact browser or IDE membership through the normal owner workflow. |
| 400 ↗ | Last-Event-ID must be a non-negative decimal integer | Review the request shape, exact Host and cursor format. Never put credentials in a URL. |
| 400 ↗ | Last-Event-ID is outside the supported range | Review the request shape, exact Host and cursor format. Never put credentials in a URL. |
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.
All referenced models remain in its components section. Browse control model definitions.