ProductOpener::APIHealth - API for executing health checks
This module implements GET /api/v3/health
It executes a series of health checks to verify that the server is functioning correctly.
Authentication is via an optional fixed API key passed the API-Key header. If the key is valid, the response includes additional details about the health checks.
Process API V3 GET /api/v3/health requests.
Executes a series of health checks to verify that the server is functioning correctly. Authentication is via an optional fixed API key passed the API-Key header. If the key is valid, the response includes additional details about the health checks.
Reference to the request object. Must have $request_ref->{oidc_user_id} set by process_auth_header() prior to this call.
On success: HTTP 200 with an object matching draft-inadarei-api-health-check-06 On error (bad health): HTTP 503 with an object matching draft-inadarei-api-health-check-06 On error (not authenticated): HTTP 401 with error details