Oriondocs
Get started
Docs›Reference›API overview

API overview

Authentication, ingest endpoints and where to find the full OpenAPI spec.

Core exposes a JSON API under /v1. The complete contract is the OpenAPI document in the repository: apps/core/openapi.yaml.

Authentication

CallerCredential
Console and admin APISign in with the admin account, then use the session token.
Apps sending logsAn ingest key: Authorization: Bearer orion_ik_.... Write-only, for one app.
AgentsA per-agent token issued at registration.

An ingest key cannot read logs or touch monitors, and an agent token cannot ingest as an app.

Common endpoints

EndpointPurpose
GET /healthLiveness.
GET /v1/diagnostics/core-workerWhether the worker is alive.
POST /v1/ingest/logsSend logs (JSON, array or NDJSON).
POST /v1/ingest/otlp/v1/logsSend logs over OTLP/HTTP.
GET /v1/logsSearch logs.
GET /v1/logs/streamLive tail over Server-Sent Events.
GET /v1/incidents/{id}/logsLogs around an incident.

See Send logs for payloads, limits and status codes.

Was this page helpful? Thanks, noted.