Log resources

Log resources let you prepare, download, and monitor the download of the HCP internal logs.

.../logs

Data typeMethodUseAccessNotes
LogDownloadStatusGETRetrieve the status of the log download in progressSystem-level user with the administrator, service, or monitor role.
N/APOSTMarks the logs with a supplied messageSystem-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/APOSTClears the log download so that it can be reinitiated.System-level user with the administrator or service role.

.../logs/prepare

Data typeMethodUseAccessNotes
LogPreparePOSTPost a system request to package logs for downloadSystem-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 typeMethodUseAccessNotes
LogDownloadPOSTStarts the log downloadSystem-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.