latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Transfers
Transfer Configuration

Remove cPanel account's archives

This function removes a cPanel user account's archives.

get/delete_account_archives

Query parameters

userstring username required
Example:username

The cPanel account username.

mountpointstring
Example:/home/example/

The filepath to the archive storage location.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "delete_account_archives",
    "output": {
      "messages": [
        "Found archive: /home/example/example.tar.gz"
      ],
      "warnings": [
        "This is a warning message."
      ]
    },
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}