Remove cPanel account's archives

This function removes a cPanel user account's archives.

SecurityBasicAuth

Request

query Parameters

user required	string <username> The cPanel account username. Example: user=username
mountpoint	string Default: "/home" The filepath to the archive storage location. Example: mountpoint=/home/example/

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/delete_account_archives

Request samples

whmapi1 --output=jsonpretty \
  delete_account_archives \
  user='username'

Response samples

application/json

{"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
}
}