Service

Liveness probe

Public liveness check — the only endpoint that needs no API key. Reports that the API is serving requests; it does not check downstream dependencies (database, payment, or image providers), so a 200 here does not promise that a generation will succeed. Per-operation availability is reported by GET /api/v1/capabilities. This is the status target of the RFC 9727 API catalog at /.well-known/api-catalog. Responses are not cached.

get/api/v1/health

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/health
  • Auth: none required

Response

API is serving requests.

status'ok' required

Always ok when the API responds. Unreachability is signalled by the transport (connection failure or a 5xx), not by this field.

servicestring required

Service name, matching info.title in the OpenAPI spec.

versionstring required

API contract version, matching info.version in the OpenAPI spec.

Changes

No recorded changes to this operation across all 1 revision of this API.