# ServiceProxy

The ServiceProxy module for UAPI.

## Return a cPanel account’s service proxying setup

 - [GET /ServiceProxy/get_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-get_service_proxy_backends.md): This function reports a cPanel account's
service proxying
configuration.

## Add cPanel account service proxying

 - [GET /ServiceProxy/set_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-set_service_proxy_backends.md): 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.

## Remove cPanel account service proxying

 - [GET /ServiceProxy/unset_all_service_proxy_backends](https://api.docs.cpanel.net/specifications/cpanel.openapi/serviceproxy/serviceproxy-unset_all_service_proxy_backends.md): 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.