latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Services

Remove cPanel account service proxying

This function removes a cPanel account's service proxying.

Note:

  • If the cPanel account is a distributed account, this function will also unset all service proxying for the cPanel account on the child node.
  • If the Web Server role is active on the server, this function rebuilds the cPanel user's web virtual hosts (vhosts) and restarts the web server.
  • If the system cannot rebuild the cPanel user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata.
  • To set a service proxying for a cPanel account, use the WHM API 1 set_service_proxy_backends function.
get/unset_all_service_proxy_backends

Query parameters

usernamestring username required
Example:username

The cPanel account's username.

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "unset_all_service_proxy_backends",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}