Admin Endpoints

These endpoints are primarily used for service checks and operational visibility.

GET /v1/admin/health

Returns a lightweight health result for the running service.

This endpoint does not require authentication.

Request

GET /v1/admin/health

Response (200 OK)

{
  "status": "healthy",
  "storage": "ok"
}

| Field | Description | |---|---| | status | Service health status | | storage | High-level storage readiness indicator |

Example

curl https://your-cortexdb/v1/admin/health

---

GET /v1/admin/metrics

Returns aggregate API metrics as JSON.

This endpoint requires authentication.

Request

GET /v1/admin/metrics
Authorization: Bearer <api-key>

Response (200 OK)

{
  "requests_total": 1280,
  "requests_active": 3,
  "errors_total": 7,
  "rate_limited_total": 2
}

| Field | Description | |---|---| | requests_total | Total API requests handled | | requests_active | Currently active requests | | errors_total | Total requests that resulted in errors | | rate_limited_total | Total requests rejected by rate limiting |

Example

curl https://your-cortexdb/v1/admin/metrics \
  -H "Authorization: Bearer your-api-key"