Skip to main content
GET
Healthcheck Deep

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

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 | null

Optional per-service error messages when a service check fails

meta
Meta · object | null

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