Reference

GET /public/v1/healthz

The live health probe on the public ring. Returns a small JSON body indicating the hub is serving; used by monitors, load balancers and integration smoke tests.

2 min read

GETHTTP method
NoneAuth
publicRing

Endpoint

MethodGET
Path/public/v1/healthz
Ringpublic (unauthenticated)

Parameters

None. This is a parameterless read.

Response

A 200 with a small JSON object indicating the service is healthy. The body is safe to cache briefly and contains no sensitive data. A non-2xx (or a 503) indicates the hub is not currently serving — for example during a migration-drift guard, when the probe fails closed rather than lying about readiness.

Errors

A 503 means unhealthy — do not treat it as an application error to retry blindly; it is a signal that the platform is not ready. A 429 means you exceeded the 60 req/60s window.

Frequently asked questions

Should I poll healthz aggressively?

No. It shares the public ring's 60 req/60s per-IP limit, so a tight poll will throttle. A monitor checking every few seconds is fine; a per-request health check is not.

Does a 200 mean my integration will work?

It means the hub is serving. It does not validate your credentials or your specific request — for that, call the actual endpoint you depend on in your smoke test.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.