Remove cPanel account service proxying

This function removes a cPanel account's service proxying.

Note:

  • 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 UAPI set_service_proxy_backends function.
Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  ServiceProxy \
  unset_all_service_proxy_backends

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "unset_all_service_proxy_backends",
  • "module": "ServiceProxy",
  • "result": {
    • "data": null,
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}