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 the most recent health check failed.

Request Parameters
name type description
ignore query Names of components for whom a failed health check does not result in a failure of a health check for the entire node.
Response Body
media type data type
application/json 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)