> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # List the subscriptions needing attention > Returns one keyset page of the tenant's subscriptions that need an operator's attention, ordered by attention rank, then most recent failure, then id. Each item carries only non-secret operational state and the period's attempt counts: never an endpoint, credential, signing secret, or raw error. To read the next page, send `next_cursor` as `cursor` with the same `from` and `to`. Authorization checks the resource `dashboard` and the action `get`. ## OpenAPI ````yaml /en/openapi/v3-current/streaming-hub.yaml get /v1/dashboard/subscriptions openapi: 3.1.0 info: title: Lerian Streaming Hub API version: 1.2.0 contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio license: name: Lerian Studio General License description: >- The Streaming Hub control-plane API. Streaming Hub is Lerian's managed event-delivery edge: it consumes CloudEvents from the platform's internal streaming backbone and fans them out to a tenant's own external destinations — webhooks, Amazon SQS, RabbitMQ, Amazon EventBridge, or a pull inbox. This API lets a tenant browse the manifest-fed event catalog, create and manage delivery subscriptions, verify and rotate their credentials, read delivery health, and pull entitled events. An RFC 9457 `application/problem+json` error body carries `type`, `title`, and `status`. An error the hub raises adds `detail` and a stable low-cardinality `code` you can branch on; a request the framework rejects before the operation runs, such as a malformed or schema-invalid one, carries no `code`. In a `5xx`, `detail` is the static `"internal error"`. Mutating operations require an `X-Idempotency` header for at-most-once semantics; a replayed request returns the original response byte-for-byte with `X-Idempotency-Replayed: true`. The catalog and the pull events surface are tenant-scoped through the bearer JWT; the operational probe endpoints (`/healthz`, `/readyz`, `/version`, `/runtime`, `/metrics`) are unauthenticated. Streaming Hub is closed source under the Lerian Studio General License. servers: - url: https://streaming-hub.sandbox.lerian.net security: - BearerAuth: [] tags: - name: Catalog description: Browse the manifest-fed catalog of event types available for subscription. - name: Subscriptions description: >- Create, read, update, and delete delivery subscriptions, and drive the destination verification lifecycle (ping, verify, credential, delegated grant, secret rotation, health). - name: Event Delivery description: >- Pull entitled events for a pull-sink subscription (cursor-as-acknowledgment read). - name: Dashboard description: >- The read-only operational dashboard: a consistent snapshot of ingestion, push delivery, and pull eligibility, plus the paged list of subscriptions that need attention. It never consumes events and never returns a secret. - name: Admin description: Cross-tenant operator forensics. Requires an operator authorization scope. - name: Operational description: Unauthenticated liveness, readiness, build, runtime, and metrics probes. paths: /v1/dashboard/subscriptions: get: tags: - Dashboard summary: List the subscriptions needing attention description: >- Returns one keyset page of the tenant's subscriptions that need an operator's attention, ordered by attention rank, then most recent failure, then id. Each item carries only non-secret operational state and the period's attempt counts: never an endpoint, credential, signing secret, or raw error. To read the next page, send `next_cursor` as `cursor` with the same `from` and `to`. Authorization checks the resource `dashboard` and the action `get`. operationId: getDashboardNeedsAttention parameters: - name: from in: query required: false description: >- The inclusive start of the period, an RFC 3339 instant. Required when `cursor` is present. schema: type: string format: date-time - name: to in: query required: false description: >- The exclusive end of the period, an RFC 3339 instant. Required when `cursor` is present. schema: type: string format: date-time - name: window_hours in: query required: false description: >- A rolling period width in whole hours, from `1` to `720`, resolved against this request's own snapshot instant. It cannot be sent with `from` or `to`, and it applies to the first page only: a page with `cursor` repeats the first page's `window_start` and `window_end` as `from` and `to`. schema: type: integer - name: limit in: query required: false description: >- The page size, from `1` to `50`. Defaults to `20`. A value out of range is rejected, not clamped. schema: type: integer - name: cursor in: query required: false description: >- The `next_cursor` of the previous page. It is signed and bound to the period and to the caller, so repeat `from` and `to` unchanged. schema: type: string responses: '200': description: A page of subscriptions needing attention. headers: Cache-Control: $ref: '#/components/headers/NoStore' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/json: schema: $ref: '#/components/schemas/NeedsAttentionPage' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': description: A query parameter is invalid. `code` is `validation_error`. content: application/problem+json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/InternalError' '503': $ref: '#/components/responses/RateLimiterUnavailable' security: - BearerAuth: [] components: headers: NoStore: description: Always `private, no-store`. Do not cache this response. schema: type: string enum: - private, no-store RateLimitLimit: description: >- The requests this tenant may make in one window of this route's allowance. schema: type: integer examples: - 60 RateLimitRemaining: description: The requests left in the current window. `0` on a refusal. schema: type: integer examples: - 59 RateLimitReset: description: The Unix time, in seconds, at which the current window ends. schema: type: integer examples: - 1789499562 RetryAfter: description: The whole seconds to wait before a retry. Always at least `1`. schema: type: string examples: - '1' schemas: NeedsAttentionPage: type: object additionalProperties: false properties: snapshot_at: type: string format: date-time description: The database instant the read observed (UTC, RFC 3339). examples: - '2026-09-11T12:00:00Z' window_start: type: string format: date-time description: >- The inclusive start of the resolved period (UTC, RFC 3339). Repeat it as `from` on the next page. examples: - '2026-09-10T12:00:00Z' window_end: type: string format: date-time description: >- The exclusive end of the resolved period (UTC, RFC 3339). Repeat it as `to` on the next page. examples: - '2026-09-11T12:00:00Z' items: type: array description: >- The page, ordered by attention rank, then `last_failure_at` (most recent first, never-failed last), then `subscription_id`. An empty page is `[]`. items: $ref: '#/components/schemas/NeedsAttentionItem' next_cursor: type: string description: >- The signed resume token for the next page. An empty string on the last page. examples: - '' required: - snapshot_at - window_start - window_end - items - next_cursor Error: type: object description: >- RFC 9457 `application/problem+json` document. An error the hub raises carries `detail` and the stable `code` a client branches on; a request the framework rejects before the operation runs carries no `code`. In a `5xx`, `detail` is the static `"internal error"`. properties: type: type: string format: uri description: >- A stable, versioned URI identifying the problem type (`https://errors.lerian.studio/v1/`), or `about:blank` for problems without a hub-assigned code. examples: - https://errors.lerian.studio/v1/not_found title: type: string description: A short human-readable summary — the HTTP status text. examples: - Not Found status: type: integer description: The HTTP status code, mirrored in the body. examples: - 404 detail: type: string description: >- A caller-safe human explanation of this specific occurrence. For `5xx` responses this is always the static string `"internal error"`. examples: - subscription not found code: type: string description: >- The stable, low-cardinality, machine-readable token a client branches on (for example `not_found`, `unauthorized`, `idempotency_conflict`, `validation_error`). Absent when the framework rejects the request before the operation runs. examples: - not_found required: - type - title - status NeedsAttentionItem: type: object additionalProperties: false description: >- One subscription that needs attention. Every period count is `0` when none, never `null`. properties: subscription_id: type: string format: uuid description: The subscription that needs attention. examples: - 0192f1a0-0000-7000-8000-0000000000ff sink_kind: $ref: '#/components/schemas/SinkKind' enabled: type: boolean description: The operator on/off flag. examples: - false verification_state: $ref: '#/components/schemas/VerificationState' auto_disabled: type: boolean description: Whether the hub's auto-disable tripped for this destination. examples: - true disabled_reason: type: string description: >- The fixed, secret-free auto-disable verdict token. An empty string when no verdict was recorded. examples: - consecutive_failures last_success_at: type: - string - 'null' format: date-time description: The last successful delivery (UTC, RFC 3339). `null` when none. examples: - '2026-09-10T09:30:00Z' last_failure_at: type: - string - 'null' format: date-time description: The last failed delivery (UTC, RFC 3339). `null` when none. examples: - '2026-09-11T09:29:00Z' period_delivery_attempts: type: integer description: The delivery attempts in the period. examples: - 12 period_failed_attempts: type: integer description: The failed attempts in the period. examples: - 12 period_dead_lettered_attempts: type: integer description: The dead-lettered attempts in the period. examples: - 3 attention_reasons: type: array description: >- The reasons, in severity order: `auto_disabled`, `verification_not_active`, `manually_disabled`, `dead_lettered_in_period`, `failed_in_period_without_success_after_failure`. The first reason present sets the item's rank. items: type: string enum: - auto_disabled - verification_not_active - manually_disabled - dead_lettered_in_period - failed_in_period_without_success_after_failure examples: - - auto_disabled - dead_lettered_in_period required: - subscription_id - sink_kind - enabled - verification_state - auto_disabled - disabled_reason - last_success_at - last_failure_at - period_delivery_attempts - period_failed_attempts - period_dead_lettered_attempts - attention_reasons RateLimiterUnavailableError: type: object description: The flat error body of a `503` from the rate limiter. properties: code: type: integer description: The HTTP status, repeated in the body. examples: - 503 title: type: string description: A stable machine-readable identifier. examples: - service_unavailable message: type: string description: A human-readable explanation. examples: - rate limiter temporarily unavailable required: - code - title - message SinkKind: type: string description: >- The delivery destination kind. `webhook` posts signed HTTPS requests; `pull` exposes an inbox read over `GET /v1/events`; `sqs`, `rabbitmq`, and `eventbridge` fan out to the named queue or bus. enum: - webhook - pull - sqs - rabbitmq - eventbridge VerificationState: type: string description: >- The subscription's position in the destination verification state machine. Only an `active` subscription is deliverable. A `pull` subscription is born `active` — it has no destination to probe. Every other kind is born `pending_verification` and reaches `active` on a successful probe: `POST /v1/subscriptions/{id}/ping` for a `webhook`, and `PUT /v1/subscriptions/{id}/credential` for any queue sink (`sqs`, `rabbitmq`, `eventbridge`). An `sqs` or `eventbridge` sink has a second path: register a delegated grant — which persists the coordinates and leaves this field unchanged — then call `POST /v1/subscriptions/{id}/verify`. An `active` subscription whose probe later fails becomes `degraded`. The same successful probe returns this field to `active`. This field is one half of deliverability: `enabled` is the other half, and both must hold. No probe changes `enabled` except `POST /v1/subscriptions/{id}/verify`, which on a probe success clears an auto-disable in the same transaction as the state move. enum: - pending_verification - active - degraded responses: Unauthorized: description: >- Authentication failed, or there is no trusted tenant context. `code` is `unauthorized` (uniform body — no reason is leaked). content: application/problem+json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- Access Manager denied the request ahead of the hub, with a plain-text body. On the `/v1` surface the hub itself can also answer `403` as `application/problem+json` with `code` `forbidden`: the delegated scope the request presents disagrees with the scope claim on the relayed token. content: text/plain: schema: type: string application/problem+json: schema: $ref: '#/components/schemas/Error' RateLimited: description: >- The tenant's allowance for this route is spent. `code` is `rate_limited`. Wait `Retry-After` seconds, then retry. Each tenant has three allowances: one for the catalog and the subscription list, detail, endpoint, health, and setup-artifacts reads; one for `GET /v1/events`; and one for the two dashboard routes. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' content: application/problem+json: schema: $ref: '#/components/schemas/Error' InternalError: description: >- An infrastructure fault. `code` is `internal_error` and `detail` is scrubbed to the static `"internal error"` (the cause is logged, never returned). content: application/problem+json: schema: $ref: '#/components/schemas/Error' RateLimiterUnavailable: description: >- The hub could not check the tenant's allowance because its rate-limit store is unreachable, and this deployment is set to refuse rather than to serve unmetered requests. This is a transient condition, not a quota: retry with backoff. A deployment set to fail open serves the request instead. The body is a flat JSON object, not a problem document. content: application/json: schema: $ref: '#/components/schemas/RateLimiterUnavailableError' securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- A bearer JWT issued by Access Manager. The `/v1` surface never reads a tenant from the body, path, or query. Machine callers obtain a token with the Access Manager client-credentials flow. The `/admin` surface authorizes against an operator scope and carries no tenant context. ````