Readiness check endpoint

GET /health/ready Select code sample Fetch cURL

const url = 'https://localhost:8080/health/ready';const options = {method: 'GET'};
try {  const response = await fetch(url, options);  const data = await response.json();  console.log(data);} catch (error) {  console.error(error);}

curl --request GET \  --url https://localhost:8080/health/ready

Reports whether the service can serve traffic by pinging the database, used by orchestrators and the E2E preflight check

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Service is ready

Media type application/json object database string service string status string timestamp string version string

Example

{  "database": "ok",  "service": "auth-service",  "status": "ready",  "version": "1.0.0"}

503

Section titled “503 ”

Service is not ready

Media type application/json object database string service string status string timestamp string version string

Example

{  "database": "ok",  "service": "auth-service",  "status": "ready",  "version": "1.0.0"}

Previous
Authenticated health check for IDP actions Next
Integrity Service Overview