Skip to main content
GET
/
v1
/
health
Healthcheck
curl --request GET \
  --url https://api.mixpeek.com/v1/health \
  --header 'Authorization: Bearer <token>'
{
  "status": "OK",
  "data": {
    "cache": true,
    "metadata": true,
    "vector_store": true,
    "object_storage": true,
    "task_queue": true,
    "inference": true,
    "analytics": true
  },
  "errors": {
    "cache": "<string>",
    "metadata": "<string>",
    "vector_store": "<string>",
    "object_storage": "<string>",
    "task_queue": "<string>",
    "inference": "<string>",
    "analytics": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

deep
boolean
default:false
metrics
boolean
default:false

Include Layer 2 protection metrics

Response

Successful Response

Health check response model.

status
enum<string>
required

Overall API health status

Available options:
OK,
DEGRADED
data
HealthServiceStatus · object
required

Per-service health status flags

errors
HealthServiceErrors · object

Optional per-service error messages when a service check fails

meta
Meta · object

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