v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Health

Healthcheck Deep

Full health check — pings every dependent service with aggressive per-service timeouts (500ms) so total wall time stays under ~3s even when a service is slow.

Use the deep=true query parameter for additional data-plane verification (e.g. reading from MongoDB collections, probing MVS namespaces, inspecting Celery workers).

get/v1/health/deep

Query parameters

deepboolean
metricsboolean

Include Layer 2 protection metrics

Include Layer 2 protection metrics

Response

Successful Response

status'OK' | 'DEGRADED' required

Overall health status.

metaobject nullable

Optional metadata such as configured object storage bucket/region/endpoint, API URL, and deployment health details (when deep=True)

Example response

{
  "data": {
    "cache": true,
    "metadata": true,
    "vector_store": true,
    "object_storage": true,
    "task_queue": true,
    "inference": true,
    "analytics": true
  }
}