N1 APIDemo shop

PLATFORM / Health

GET

/readyz

Can this instance take traffic

Compare

200 when PostgreSQL and Valkey both answer within 1 s, 503 otherwise, and 503 draining from the moment the process starts shutting down. Load balancers and the deploy use it. The result is reused for 1 s. Check details are shown only with the internal x-n1-health-token header, and never include hostnames or versions.

GET/readyz

Who can call this. None: public (details need the internal health token).

Headers

  • X-Request-IdstringOptional

    Your id for this request (8–128 characters of A–Z a–z 0–9 . _ : -). Echoed back in the response header and in every error, so you can quote it when reporting a problem. Core makes one if you send none.

    Example: app-7f3c2a9e-checkout

Returns

A small JSON object; see the response examples on the right.

Errors

CodeHTTPWhen
A dependency is down503A dependency is down
Shutting down503Shutting down

Every error has the same body. See Errors.

Rate limit tier

Tier: none. Over the limit you get RATE_LIMITED (HTTP 429) with a Retry-After header. See Response handling.