Readiness check endpoint

GET

/health/ready

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

200

Service is ready

application/json

Readiness status; reports whether the service can serve traffic, including its database

object

database

string

service

string

status

string

timestamp

string format: date-time

version

string

Example

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

503

Service is not ready

application/json

Readiness status; reports whether the service can serve traffic, including its database

object

database

string

service

string

status

string

timestamp

string format: date-time

version

string

Example

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