Skip to content
Download

HTTP API

The engine serves a JSON API on 127.0.0.1 at an OS-assigned port. The app shows the port under Collectors → Local OTLP receiver → Connection. The engine also prints it at start:

HTTP API server listening on :54321
Method and path Purpose
GET /api/health Health, effective OTLP ports, and port-conflict flags.
GET /api/storage/stats Row counts and database size.
POST /api/cleanup Apply retention now.
Method and path Purpose
GET /api/logs Query logs. Filters: query, severity, service, collectorId, start, end, limit.
GET /api/logs/services Distinct service names in logs.
GET /api/metrics Query metrics. Filters: name, collectorId, start, end.
GET /api/metrics/names Distinct metric names.
GET /api/traces Query traces. Filters: service, operation, minDurationMs, collectorId, start, end, limit.
GET /api/traces/{traceId} One trace with every span.
Method and path Purpose
GET /api/collectors List collectors with last-seen and error counts.
GET /api/collectors/map Nodes and edges for the collector map.
GET, PUT, DELETE /api/collectors/{id} Read, update, or remove one collector.
POST /api/collectors/register Give a branch a name and an endpoint.
POST /api/collectors/{id}/start, /stop, /restart Control a supervised collector.
GET, POST /api/collectors/{id}/sources List or add pull sources.
POST /api/collectors/{id}/sources/probe Test a source without saving.
PUT, DELETE /api/collectors/{id}/sources/{sourceId} Replace or remove one source.
Method and path Purpose
GET /api/alerts, GET /api/alerts/rules Fired alerts and rules.
POST, PUT, DELETE /api/alerts/rules… Manage rules.
POST /api/alerts/{id}/acknowledge Acknowledge one alert.
GET /api/improvements Findings from telemetry linting.
POST /api/improvements/ai Run AI analysis on the findings.
POST /api/improvements/actions Run an action for a finding.
GET /api/dashboard/summary, /volume, /services Dashboard tiles.
GET, PUT /api/settings Read or write settings. See Settings.

GET /api/logs/stream, /api/traces/stream, /api/metrics/stream, and /api/alerts/stream are Server-Sent Events. See SSE streams.