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)

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.