/ Docs
APIHealth

Ready

Kubernetes readiness probe — checks DB.

GET
/ready

Authorization

BearerAuth
AuthorizationBearer <token>

Botyard API key — see /docs/authentication.

In: header

Response Body

application/json

curl -X GET "https://example.com/ready"
null
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "error_code": "string",
  "errors": [
    {
      "pointer": "string",
      "detail": "string",
      "type": "string"
    }
  ],
  "trace_id": "string"
}

Health

Full health check — verifies database connectivity.

Live

Kubernetes liveness probe — always OK if process is running.