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": {
    "redis": true,
    "mongodb": true,
    "qdrant": true,
    "s3": true,
    "celery": true,
    "engine": true,
    "clickhouse": true
  },
  "errors": {
    "redis": "<string>",
    "mongodb": "<string>",
    "qdrant": "<string>",
    "s3": "<string>",
    "celery": "<string>",
    "engine": "<string>",
    "clickhouse": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

Query Parameters

deep
boolean
default:false

Response

Successful Response

Health check response model.

status
enum<string>
required

Overall API health status

Available options:
OK,
DEGRADED
data
object
required

Per-service health status flags

errors
object | null

Optional per-service error messages when a service check fails Optional error messages for dependent services (present when a check fails).

meta
object | null

Optional metadata such as configured S3 bucket/region/endpoint