Update cPanel account service proxying

This function lets you configure a cPanel account's service proxying.

Note:

  • If the cPanel account is a distributed account, and you call this function on the account’s parent node, the system will propagate the new service proxying to the child node.
  • If the Web Server role is active on the server, this function rebuilds the user's web virtual hosts (vhosts) and restarts the web server.
  • If the system cannot rebuild the user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata.
  • To remove an account's service proxying, use the WHM API 1 unset_all_service_proxy_backends function.
Authorizations:
query Parameters
username
required
string <username>
Example: username=example

The cPanel account's username.

string or string

The hostname or IP address to assign as the server that handles the account's service proxy requests.

This parameter defaults to the existing service proxy configuration, if one exists.

service_group
string
Value: "Mail"
Examples:
service_group=service-group-0=Mail&service-group-1=Mail&service-group-3=Mail
service_group=Mail

The name of a service group for which to assign a proxy backend. The corresponding service_group_backend value will be the service group's new proxy backend.

This parameter defaults to the existing setting, if one exists.

Note:

  • When you call this parameter, you must include a corresponding service_group_backend value.
  • To add multiple service_group values, increment the parameter name. For example, service_group-1, service_group-2, and service_group-3.
string or string
Examples:
service_group_backend=service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com&service_group_backend-3=mail.example3.com
service_group_backend=mail.example.com

The hostname or IP address of the server to assign as the corresponding service_group value's proxy backend server.

This parameter defaults to the existing setting, if one exists.

Note:

  • When you call this parameter, you must include a corresponding service_group value.
  • To add multiple service_group_backend values, increment the parameter name. For example, service_group_backend-1, service_group_backend-2, and service_group_backend-3.

Responses

Response Schema: application/json
object

Request samples

whmapi1 set_service_proxy_backends username='example'

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "set_service_proxy_backends",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}