/ Docs
APIHealth

Live

Kubernetes liveness probe — always OK if process is running.

GET
/live

Authorization

BearerAuth
AuthorizationBearer <token>

Botyard API key — see /docs/authentication.

In: header

Response Body

application/json

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

Ready

Kubernetes readiness probe — checks DB. ``spiffe_key_source`` is report-only detail and never gates readiness: the API serves dashboard and public routes that do not need SPIFFE, so a SPIRE outage must not pull it from service. SVID-authenticated requests fail closed on their own while the source is unavailable (#355).

Inbound emails

Botyard REST API endpoints for inbound emails.