API Documentation

IngestCore REST API v1. All endpoints require authentication via API key in the Authorization header.

Authentication

Authorization: Bearer YOUR_API_KEY

Endpoints

POST/api/v1/ingest

Submit data records for processing. Accepts JSON array of records.

Request

{
  "pipeline": "default",
  "records": [
    {"id": "rec_001", "type": "event", "data": {...}},
    {"id": "rec_002", "type": "metric", "data": {...}}
  ]
}

Response

{
  "accepted": 2,
  "pipeline": "default",
  "batch_id": "batch_8f3a2b"
}

GET/api/v1/pipelines

List all configured processing pipelines and their status.

[
  {"name": "default", "status": "active", "throughput": "1.2k/s"},
  {"name": "analytics", "status": "active", "throughput": "340/s"}
]

GET/api/v1/health

Engine health check. Returns 200 if operational.

{"status": "healthy", "uptime": "14d 6h", "version": "1.4.2"}

GET/metrics

Prometheus-compatible metrics endpoint. Exposes pipeline throughput, error rates, queue depths, and system metrics.

Rate Limits

Default: 1000 requests/min per API key. Contact support for higher limits.

Errors

{"error": "unauthorized", "message": "Invalid or missing API key"}  → 401
{"error": "rate_limited", "message": "Too many requests"}           → 429
{"error": "validation", "message": "Invalid record format"}         → 422