Readiness check — verifies DB, Redis, and Authentik

GET

/health/readiness

const url = 'https://api.krakenkey.io/health/readiness';
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.krakenkey.io/health/readiness

Responses

200

All dependencies healthy

The Health Check is successful

application/json

object

status

string

info

object

key

additional properties

object

status

required

string

key

additional properties

any

error

object

key

additional properties

object

status

required

string

key

additional properties

any

details

object

key

additional properties

object

status

required

string

key

additional properties

any

Example

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

503

One or more dependencies unhealthy

The Health Check is not successful

application/json

object

status

string

info

object

key

additional properties

object

status

required

string

key

additional properties

any

error

object

key

additional properties

object

status

required

string

key

additional properties

any

details

object

key

additional properties

object

status

required

string

key

additional properties

any

Example

{
  "status": "error",
  "info": {
    "database": {
      "status": "up"
    }
  },
  "error": {
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  },
  "details": {
    "database": {
      "status": "up"
    },
    "redis": {
      "status": "down",
      "message": "Could not connect"
    }
  }
}