System

Health checks and helper endpoints that keep integrations reliable.

Liveness probe

get

Quick check to confirm the BridgeAPI service is running. Returns immediately with 200 when healthy.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

OK

404

Not found

get

/healthz

Health check

curl -X GET https://api.bridgeapi.store/healthz

No content

Readiness probe

get

Returns 200 when BridgeAPI has finished booting and is ready to accept customer requests.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

OK

404

Not found

get

/readyz

Readiness check

curl -X GET https://api.bridgeapi.store/readyz

No content

Prometheus metrics (text/plain)

get

Streams Prometheus metrics so your monitoring tools can track latency, errors, and queue depth.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Responses

200

Metrics

text/plain

404

Not found

get

/metrics

Fetch metrics snapshot

curl -X GET https://api.bridgeapi.store/metrics