Health
Service health and liveness probes — for partner integration monitoring and uptime dashboards. Unauthenticated endpoint.
🔬Preview stream (/api/v1-preview)
These endpoints are reserved or behind feature flags and may change before promotion to stable. Operations badged “Reserved — not yet available”return
404 (or 501) today; do not build against them yet. This spec is generated from the canonical contract — see the stable /api/v1 reference for production-ready endpoints.Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/health"{
"status": "healthy",
"version": "1.0.0",
"timestamp": "2026-04-24T09:30:15Z",
"dependencies": {
"database": "healthy",
"cache": "healthy",
"gateway": "healthy"
}
}{
"type": "https://docs.cresoracommerce.com/errors/rate_limit_exceeded",
"title": "Too Many Requests",
"status": 429,
"detail": "Too many requests. Retry after 60 seconds.",
"instance": "urn:cresora:trace:0191c8a2-dbcd-7a31-8c44-d8f1e2c3a4b5",
"code": "rate_limit_exceeded",
"retryable": true,
"error_id": "0191c8a2-dbcd-7a31-8c44-d8f1e2c3a4b5"
}{
"type": "https://docs.cresoracommerce.com/errors/internal_error",
"title": "Internal Server Error",
"status": 500,
"detail": "Health probe failed to compute dependency status.",
"instance": "urn:cresora:trace:0191c8a2-fbcd-7a31-8c44-d8f1e2c3a4b5",
"code": "internal_error",
"retryable": true,
"error_id": "0191c8a2-fbcd-7a31-8c44-d8f1e2c3a4b5"
}{
"type": "https://docs.cresoracommerce.com/errors/maintenance_mode",
"title": "Service Unavailable",
"status": 503,
"detail": "Planned maintenance window. Retry after 120s.",
"instance": "urn:cresora:trace:0191c8a2-abcd-7a31-8c44-d8f1e2c3a4b5",
"code": "maintenance_mode",
"retryable": true,
"error_id": "0191c8a2-abcd-7a31-8c44-d8f1e2c3a4b5"
}