PSP > Health Check

Get application health ping.

get

Responses

200Success

application/json

503Error

get

HTTPcURLJavaScriptPython

GET /api/v1/psp/health-check/liveness HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Accept: */*

{
  "live": true
}

Get application health report.

get

Responses

200

The Health Check is successful

application/json

503

The Health Check is not successful

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/psp/health-check/readiness HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Accept: */*

{
  "status": "ok",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {},
  "details": {
    "database": {
      "status": "up"
    }
  }
}