System — PropZolo API

GET/api/health

Liveness and readiness

Without parameters a liveness probe (no dependencies touched). With `ready=1` it also checks Postgres (as the app role) and Redis and answers 503 when either is down.

Access: No authentication.

Parameters

readyquery: string
Also probe the database and Redis.

Response · 200

datarequired: Health
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/api/health'

Response example

{
  "data": {
    "status": "ok",
    "time": "2026-10-06T05:30:00.000Z",
    "uptime_s": 0,
    "checks": {
      "database": {
        "ok": true,
        "ms": 0
      },
      "redis": {
        "ok": true,
        "ms": 0
      }
    }
  },
  "meta": {}
}

Errors

422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.
503 A dependency is unavailable.

GET/v1/openapi.json

OpenAPI 3.1 document

This document. Cached by clients for five minutes; supports If-None-Match.

Access: No authentication.

Parameters

If-None-Matchheader: string
ETag of the copy the client holds; an unchanged resource answers 304 without a body.

Response · 200

Returned as is.

Request

curl -X GET 'https://api.propzolo.com/v1/openapi.json'

Response example

{}

Errors

304 Not modified.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/api/health

Liveness and readiness

Without parameters a liveness probe (no dependencies touched). With `ready=1` it also checks Postgres (as the app role) and Redis and answers 503 when either is down.

Access: No authentication.

Parameters

readyquery: string
Also probe the database and Redis.

Response · 200

datarequired: Health
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/api/health'

Response example

{
  "data": {
    "status": "ok",
    "time": "2026-10-06T05:30:00.000Z",
    "uptime_s": 0,
    "checks": {
      "database": {
        "ok": true,
        "ms": 0
      },
      "redis": {
        "ok": true,
        "ms": 0
      }
    }
  },
  "meta": {}
}

Errors

422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.
503 A dependency is unavailable.