Log resources let you prepare, download, and monitor the download of the HCP internal logs.
.../logs
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| LogDownloadStatus | GET | Retrieve the status of the log download in progress | System-level user with the administrator, service, or monitor role. | |
| N/A | POST | Marks the logs with a supplied message | System-level user with the administrator or service role. | You supply the message at the end of the command. Use the plus (+) sign or %20 to make spaces between words. |
| N/A | POST | Clears the log download so that it can be reinitiated. | System-level user with the administrator or service role. |
.../logs/prepare
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| LogPrepare | POST | Post a system request to package logs for download | System-level user with the administrator or service role. | Packages all logs, regardless of log type. If prepared logs are not downloaded withing twenty four hours, the package is deleted. |
.../logs/download
| Data type | Method | Use | Access | Notes |
|---|---|---|---|---|
| LogDownload | POST | Starts the log download | System-level user with the administrator or service role. | Downloaded logs come as .zip files. For HCP nodes, you have control over which log types are downloaded. |