Health

Get Health

Changed on

Returns agridata.ch's readiness and an informational summary of the connected data providers. A data provider being DOWN does not affect agridata.ch's status or the HTTP code.

get/api/health

Request

  • The document declares no server URL.
  • Auth
    OpenID Connect (http://localhost:6999/realms/agate/.well-known/openid-configuration, scopes: agridata.ch.Agridata_Admin, agridata.ch.Agridata_Support, agridata.ch.Agridata_Datenbezueger, agridata.ch.Agridata_Datenanbieter)

Response

OK

agridataStatus'UP' | 'DOWN' | 'HEALTH_CHECK_NOT_IMPLEMENTED'

Health status. HEALTH_CHECK_NOT_IMPLEMENTED marks systems without a health probe

Changes

  • 75957f6bdc66Revision changes
    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_CAPACITY_EXHAUSTED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

    • warning

      added the new EXPORT_LIMIT_EXCEEDED enum value to the response property for the response status

  • 1aa7b6ad5bccRevision changes
    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status

    • warning

      added the new UID_CLAIM_MISSING enum value to the response property for the response status