Add cPanel account service proxying

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

Note:

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 UAPI unset_all_service_proxy_backends function.

SecurityBasicAuth

Request

query Parameters

	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 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. `Mail` — The Mail service group. 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`, `service_group-1`, and `service_group-2`. Value: "Mail" Examples: Add multiple service backend groups. service_group=Mail&service-group-1=Mail&service-group-2=Mail Add a single service backend group. service_group=Mail
	string or string 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`, `service_group_backend-1`, and `service_group_backend-2`. Examples: Add multiple service group backend servers. service_group_backend=mail.example.com&service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com Add a single service group backend server. service_group_backend=mail.example.com

Responses

200

HTTP Request was successful.

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

get/ServiceProxy/set_service_proxy_backends

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

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

Response samples

application/json

{"apiversion": 3,
"func": "set_service_proxy_backends",
"module": "ServiceProxy",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}