API resources

Operational

Health

Public, unauthenticated liveness probe. Returns only overall status; detailed checks are available on the internal /up endpoint.

Public · no authentication required

1

Endpoints

GET

Methods

Read only

Access

Base path

/api/v1/health

Example request

    curl -X GET 'https://dzconfig.com/api/v1/health' \
  -H 'Accept: application/json'

Endpoints

Method	Path	Purpose
GET	/api/v1/health	Liveness probe

200 example response

    {
    "status": "healthy"
}

503 example response

    {
    "status": "unhealthy"
}

Status codes

Code	Label	Description
200	OK	Returned for successful reads, updates, and deletes.
429	Rate limited	Too many API requests in a short period.
503	Service unavailable	A health check probe failed.