Health

Public, unauthenticated probe for monitoring database, cache, storage, and queue connectivity.

Public · no authentication required

Endpoints

GET

Methods

Read only

Access

Base path

/api/v1/health

Example request

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

Endpoints

Method	Path	Purpose
GET	`/api/v1/health`	Health probe

Example response

{
    "status": "healthy",
    "checks": {
        "database": {
            "status": "ok"
        },
        "cache": {
            "status": "ok"
        },
        "storage": {
            "status": "ok"
        },
        "queue": {
            "status": "ok",
            "connection": "database",
            "driver": "database",
            "queue": "default",
            "verification": "configuration-only"
        }
    },
    "timestamp": "2026-05-29T09:55:00+00:00"
}

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.