Health check report resources let you prepare, download, cancel, and retrieve the status of HCP health check reports.
.../healthCheckReport
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| healthCheckDownloadStatus | GET | Retrieve the status of the health check reports download in progress. | System-level user with the administrator or service role |
.../healthCheckReport/prepare
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| healthCheckPrepare | POST | Post a system request to prepare the health check reports. | System-level user with the administrator or service role | Health check reports can be prepared only on nodes that are running and available. |
.../healthCheckReport/download
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| healthCheckDownload | POST | Post a system request to start the health check reports download. | System-level user with the administrator or service role | The 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.