Health check report resources

Health check report resources let you prepare, download, cancel, and retrieve the status of HCP health check reports.

.../healthCheckReport

Data typeMethodUseAccessNotes
healthCheckDownloadStatusGETRetrieve the status of the health check reports download in progress.System-level user with the administrator or service role

.../healthCheckReport/prepare

Data typeMethodUseAccessNotes
healthCheckPreparePOSTPost a system request to prepare the health check reports.System-level user with the administrator or service roleHealth check reports can be prepared only on nodes that are running and available.

.../healthCheckReport/download

Data typeMethodUseAccessNotes
healthCheckDownloadPOSTPost a system request to start the health check reports download.System-level user with the administrator or service roleThe health check reports archive can be downloaded at any time after the health check reports are successfully prepared.

.../healthCheckReport/cancel

This resource has no data types.