Health
This API endpoint verifies that the server is operational.
The response from the server is either 200 or 500:
- 200 - OPA service is healthy. If bundles is true, then all configured bundles have been activated. If plugins is true, then all plugins are in an 'OK' state.
- 500 - OPA service is not healthy. If bundles is true, at least one of configured bundles has not yet been activated. If plugins is true, at least one plugins is in a 'not OK' state.
Note This check is only for initial bundle activation. Subsequent downloads will not affect the health check.
Use the status endpoint (in the (management API)[management.html]) for more fine-grained bundle status monitoring.
Query parameters
Reports on bundle activation status (useful for 'ready' checks at startup).
This includes any discovery bundles or bundles defined in the loaded discovery configuration.
Reports on plugin status
String parameter to exclude a plugin from status checks. Can be added multiple times. Does nothing if plugins is not true. This parameter is useful for special use cases where a plugin depends on the server being fully initialized before it can fully initialize itself.
Response
OPA service is healthy