Health Check - Truthlocks Documentation

Health Check

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

{
  "status": "ok"
}

GET

healthz

Health Check

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

{
  "status": "ok"
}

Simple liveness probe that returns 200 OK if the service is running. Used by load balancers and orchestrators.

X-API-Key

string

header

required

API key for machine-to-machine authentication

200 - application/json

Service is healthy

status

enum<string>

Available options:

ok