Return service readiness and dependency checks.

GET

/readyz

const url = 'https://api.dev.iot-sens.schlossers.at/readyz';
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://api.dev.iot-sens.schlossers.at/readyz

Responses

200

The service is ready to receive traffic.

application/json

object

status

required

string

Allowed values: ready not_ready

service

required

string

>= 1 characters

timestamp

required

string format: date-time

correlationId

required

string

>= 1 characters

checks

required

Array<object>

object

name

required

string

>= 1 characters

status

required

string

Allowed values: ok failed

message

string

Example

{
  "status": "ready",
  "checks": [
    {
      "status": "ok"
    }
  ]
}

503

The service is alive but not ready to receive traffic.

application/json

object

status

required

string

Allowed values: ready not_ready

service

required

string

>= 1 characters

timestamp

required

string format: date-time

correlationId

required

string

>= 1 characters

checks

required

Array<object>

object

name

required

string

>= 1 characters

status

required

string

Allowed values: ok failed

message

string

Example

{
  "status": "ready",
  "checks": [
    {
      "status": "ok"
    }
  ]
}