healthApi

Provides an instance of the HealthApi interface for checking the health of the API and database.

The HealthApi allows you to interact with health-check endpoints, ensuring that the API and associated database are operational and responding as expected.

This property is lazily instantiated using the ApiClient configured for the system, which means it will be initialized once upon first access and reused thereafter.

The health checks typically cover a variety of response status codes, indicating the state of the API:

• 200: Successful response, API and database are up and running.

• 400, 401, 403, 404, 405, 503: Various error states indicating issues with API access, authorization, unavailability, or misconfiguration.

Usage of this API generally involves calling its health-check methods to ensure system robustness before performing more critical operations.