Skip to main content

​
API Reference

LogClaw exposes APIs through three access patterns:
  1. LogClaw Cloud (otel.logclaw.ai) — all endpoints are authenticated via x-logclaw-api-key header and routed through the Auth Proxy. Use this for LogClaw Cloud deployments. Every endpoint in this reference includes an interactive playground — paste your API key and send requests directly from the docs.
  2. Dashboard Proxy — the Next.js Dashboard proxies requests to backend services under /api/<service>/. Use this for browser-based access in self-hosted deployments.
  3. Direct Service Access — each backend service exposes its own API on its Kubernetes ClusterIP service. Use this for programmatic access from within the cluster.

​
Authentication

LogClaw Cloud requires an API key for all API requests. Include the x-logclaw-api-key header with every request:
curl -H "x-logclaw-api-key: lc_proj_your_key_here" \
  https://otel.logclaw.ai/api/agent/health
Generate keys from your project dashboard at console.logclaw.ai under Settings → API Keys. See API Keys for details.Self-hosted deployments do not require API keys — access is controlled at the Kubernetes NetworkPolicy level.
The Auth Proxy automatically injects the correct tenant_id into all requests based on your API key’s project. You never need to specify a tenant ID manually.

​
Try It Live

Every endpoint page includes an interactive API Playground on the right side. Enter your x-logclaw-api-key and send real requests to otel.logclaw.ai directly from the docs.

​
Service Endpoints

ServiceCloud (otel.logclaw.ai)Dashboard ProxyDirect (in-cluster)Port
IngestionPOST /v1/logs/api/otel/v1/logslogclaw-otel-collector:43184317 (gRPC), 4318 (HTTP)
API Keys/api/admin/api-keys/api/admin/api-keysDashboard internal—
Bridge/api/bridge/*/api/bridge/*logclaw-bridge:80808080
OpenSearch/api/opensearch/*/api/opensearch/*logclaw-opensearch:92009200
Ticketing/api/ticketing/*/api/ticketing/*logclaw-ticketing-agent:1808118081
Infrastructure/api/agent/*/api/agent/*logclaw-agent:80808080
Airflow/api/airflow/*/api/airflow/*logclaw-airflow-webserver:80808080
Feast/api/feast/*/api/feast/*logclaw-feast:65676567

​
All Endpoints

MethodPathDescription
POST/v1/logsIngest logs (OTLP/HTTP)
GET/api/admin/api-keysList API keys
POST/api/admin/api-keysCreate API key
DELETE/api/admin/api-keysRevoke API key
GET/api/bridge/healthBridge health
GET/api/bridge/configBridge configuration
GET/api/ticketing/api/incidentsList incidents
GET/api/ticketing/api/v1/configRuntime configuration
GET/api/agent/healthAgent liveness
GET/api/agent/metricsInfrastructure metrics
GET/api/opensearch/_cat/indicesList indices

​
Common Response Formats

​
Health Checks

All services implement a standard health check: 
{
  "status": "ok"
}

​
Error Responses

{
  "error": "description of the error",
  "status": 500
}

​
Authentication Errors

{
  "error": "Missing x-logclaw-api-key header"
}

​
Proxy Errors

When a backend service is unreachable, the Auth Proxy returns: 
{
  "error": "Failed to forward request to Console API",
  "status": 502
}