v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
LogManager
Logs

Delete a log archive file

Delete a specific log archive file from the authenticated user's ~/logs directory.

get/LogManager/delete_archive

Query parameters

filestring required
Example:example.com-Aug-2024.gz

The log archive filename to delete. Requirements:

  • Must reside in the user's ~/logs directory.
  • Must end with .gz.
  • Must not contain path traversal characters.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete_archive",
  "module": "LogManager",
  "result": {
    "status": 1
  }
}