Skip to content

API Reference

The API sidecar exposes:

EndpointPurpose
GET /healthRuntime, storage, ingest, auth, and alert health.
GET /openapi.jsonOpenAPI 3.1 JSON document.
GET /openapi.yamlOpenAPI 3.1 YAML document.
GET /docsScalar API reference for the sidecar API.
POST /api/ingestIngest NDJSON-style log records.
GET /api/logsQuery indexed logs.
GET /api/logs/aggregateAggregate logs by level, event, field, or correlation.
GET /api/alerts/configRead alert policy.
PUT /api/alerts/configUpdate alert policy.
POST /api/alerts/test-webhookSend a test webhook payload.
POST /api/reindexRebuild the SQLite index from logs.

Protected API routes accept bearer token or basic auth when configured.