API Reference
Health
Access documentation system health information and the individual checks used to calculate the overall score.
Endpoints
GET/api/v1/health
Documentation health
Returns the current health of the documentation system and the individual checks used to calculate the overall score.
Request
GET
/api/v1/healthThis operation does not require authentication or parameters.
GET
/api/v1/healthcurl https://docops-gamma.vercel.app/api/v1/healthResponse
Response
A successful request returns a 200 response with a JSON object containing the overall score, status, and individual health checks.
scoreintegerOverall documentation health score from 0 to 100.
statusstringOverall documentation health status: healthy, needs-attention, or unhealthy.
checksHealthCheck[]Individual checks used to calculate the documentation health score.