Readiness Probe - Truthlocks Documentation

Readiness Check

curl --request GET \
  --url https://api.truthlocks.com/readyz \
  --header 'X-API-Key: <api-key>'

{
  "status": "ready"
}

GET

readyz

Readiness Check

curl --request GET \
  --url https://api.truthlocks.com/readyz \
  --header 'X-API-Key: <api-key>'

{
  "status": "ready"
}

Detailed health check that verifies connectivity to upstream dependencies like Postgres, Redis, and NATS.

X-API-Key

string

header

required

API key for machine-to-machine authentication

Service is ready

status

enum<string>

Available options:

ready