Check API and PostgreSQL readiness

Health · getReadiness

GET/health/ready

Base URL: https://api.businessmode.io/v1

Authentication

Public

The requirement above comes from this operation's OpenAPI security declaration. See Authentication.

Parameters

No path, query, or header parameters are defined.

Request body

No request body is defined.

Responses

For status codes, request IDs, and safe retry decisions, see Errors & recovery. Known-code descriptions below are operation-specific, not a complete global error enum.

200 Successful response.

Content type: application/json

object · DatabaseHealthResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
databasestringYesConstant: ok
statusstringYesConstant: ok

503 A required operation-specific provider or PostgreSQL is unavailable.

Content type: application/json

object · DatabaseUnavailableResponse
  • No additional properties
FieldTypeRequiredDescription / constraints
databasestringYesConstant: unavailable
statusstringYesConstant: unavailable

← All API operations