Readiness probe

GET

/health/ready

const url = 'https://example.com/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://example.com/health/ready

Responses

200

Default Response

application/json

object

status

required

string

Allowed values: ready

cdc

required

object

enabled

required

boolean

connected

required

boolean

Example

{
  "status": "ready"
}

503

Default Response

application/json

object

statusCode

required

number

code

required

string

Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR

error

required

string

message

required

string

details

Array

Example

{
  "code": "VALIDATION_ERROR"
}