Ollacore
API reference

Operational

Health and telemetry. Metrics are not publicly exposed.

Credential: none / internal

3 operations · 2 captured against the live API.

Every example below is a real exchange recorded against a throwaway tenant, then redacted — not a shape transcribed from a schema. Ids and timestamps are stable fixtures so the same request always reads the same way. Back to the full index →

Health #

GET /health/live #

Liveness

Returns 200 with the text ok whenever the process is serving HTTP. It checks no dependency. Unauthenticated.

live captured live

Request

curl -X GET https://api.ollacore.com/health/live
ParameterTypeDescription
X-Request-Id header string Your own id for this request. It is returned in the response's X-Request-Id header and attached to every log line kept for the request, so quote it when you contact support. Use printable ASCII. Without it, the server assigns a UUID.

Response · 200

ok
GET /health/ready #

Readiness (dependencies)

Checks PostgreSQL with SELECT 1, then runs a Valkey command, then sends a HEAD request to the object store. Returns 503 naming the first dependency that failed, with its error as plain text, or 200 with ready. Unauthenticated.

ready captured live

Request

curl -X GET https://api.ollacore.com/health/ready
ParameterTypeDescription
X-Request-Id header string Your own id for this request. It is returned in the response's X-Request-Id header and attached to every log line kept for the request, so quote it when you contact support. Use printable ASCII. Without it, the server assigns a UUID.

Response · 200

ready
Errors · 503
StatusWhen
503dependency down
GET /metrics #

Prometheus metrics — internal only

Prometheus text for this process: connection gauges, counters for messages, outbox, jobs and auth failures, and RTC series. Labels may carry a tenant id but never a room, principal, device or message id, and no tenant content is exposed. The public edge answers this path with 403, so it is scraped only on the internal network.

metrics captured on a test deployment

Request

curl -X GET https://api.ollacore.com/metrics
ParameterTypeDescription
X-Request-Id header string Your own id for this request. It is returned in the response's X-Request-Id header and attached to every log line kept for the request, so quote it when you contact support. Use printable ASCII. Without it, the server assigns a UUID.

Response · 200

# HELP chatbox_auth_failures_total Rejected authentication attempts
# TYPE chatbox_auth_failures_total counter
chatbox_auth_failures_total 10
# HELP chatbox_control_plane_rate_limited_total Rejected control-plane requests over the per-key rate limit
# TYPE chatbox_control_plane_rate_limited_total counter
chatbox_control_plane_rate_limited_total 1
# HELP chatbox_control_plane_replays_total Rejected control-plane nonce replays
# TYPE chatbox_control_plane_replays_total counter
chatbox_control_plane_replays_total 1
# HELP chatbox_http_requests_total Total HTTP requests handled
# TYPE chatbox_http_requests_total counter
chatbox_http_requests_total 5848
# HELP chatbox_jobs_failed_total Background jobs that exhausted retries
# TYPE chatbox_jobs_failed_total counter
chatbox_jobs_failed_total 0
# … (further series omitted)
Prometheus text format. Not exposed publicly — the edge refuses /metrics; scrape it from inside your network.