Initializing help system before first use

StatusEndpoints

Endpoints for querying the health of the component

GET /status/healthcheck

Returns a JSON document describing the result of the most recent health check on this node of the component. Note that health checks are generally performed asynchronously, every 5 minutes. The only exception to this is when a successful health check has not yet been performed

Response Body
media type data type
application/json HealthCheckSummary (JSON)

GET /status/healthchecks

Returns a JSON document describing the result of the most recent health check on all nodes of the component. Note that health checks are generally performed asynchronously, every 5 minutes. The only exception to this is when a successful health check has not yet been performed. Note that if nodes of a component have been scaled down, their latest health checks will still be returned by this webservice & will eventually show as failures as they have not been updated.

Response Body
media type data type
application/json array of HealthCheckSummary (JSON)

DELETE /status/cachedhealthcheck

Clear any previous health check, to ensure it's regenerated fresh next time a health check is requested.

Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)