health

OSA Webhook API

GET/api/livez

Liveness probe

Does not touch Postgres/OpenSearch — always 200 while the process is up.

Responses

200 Alive
statusenumrequired
ok
cURL
curl -X GET https://osawebhook.defenderx.sentrixsolution.com/api/livez
JavaScript
const res = await fetch("https://osawebhook.defenderx.sentrixsolution.com/api/livez", {
  method: "GET"
});
const data = await res.json();
Response 200
{
  "status": "ok"
}
GET/api/health

Readiness probe

200 only when both Postgres and OpenSearch are reachable, otherwise 503.

Responses

200 All dependencies healthy503 One or more dependencies unreachable
statusenumrequired
okdegraded
checksobjectrequired
postgresenum
okerror
opensearchenum
okerror
cURL
curl -X GET https://osawebhook.defenderx.sentrixsolution.com/api/health
JavaScript
const res = await fetch("https://osawebhook.defenderx.sentrixsolution.com/api/health", {
  method: "GET"
});
const data = await res.json();
Response 200
{
  "status": "ok",
  "checks": {
    "postgres": "ok",
    "opensearch": "ok"
  }
}