Health API

Liveness and readiness probes for load balancers and orchestrators.

Every operation of the API reference is generated from the contract the API serves, version 0.1.0. Replace YOUR_API_KEY in the samples with your key.

Liveness probe

GET/healthz

Answers while the process can serve HTTP, without checking any dependency.

Authentication: None: anyone may call it, within a budget per client address where the description says so.

Responses

Responses of Liveness probe
Status	Meaning	Body
200 OK	The process is up.	HealthStatus (application/json)
Any other status	An error, as RFC 9457 problem details.	Problem (application/problem+json)

Sample

curl https://api.zerocaptcha.io/healthz

const response = await fetch("https://api.zerocaptcha.io/healthz");
console.log(response.status, await response.text());

import requests

response = requests.get(
    "https://api.zerocaptcha.io/healthz",
    timeout=30,
)
print(response.status_code, response.text)

Readiness probe

GET/readyz

Answers when the service can reach its database, which must reply within two seconds.

Authentication: None: anyone may call it, within a budget per client address where the description says so.

Responses

Responses of Readiness probe
Status	Meaning	Body
200 OK	Ready for traffic.	HealthStatus (application/json)
503 Service Unavailable	The database cannot be reached.	Problem (application/problem+json)
Any other status	An error, as RFC 9457 problem details.	Problem (application/problem+json)

Sample

curl https://api.zerocaptcha.io/readyz

const response = await fetch("https://api.zerocaptcha.io/readyz");
console.log(response.status, await response.text());

import requests

response = requests.get(
    "https://api.zerocaptcha.io/readyz",
    timeout=30,
)
print(response.status_code, response.text)