---
title: "Add cPanel account service proxying"
method: GET
path: "/ServiceProxy/set_service_proxy_backends"
tags: ["ServiceProxy"]
---

# Add cPanel account service proxying

`GET /ServiceProxy/set_service_proxy_backends`

This function lets you configure a cPanel account's
[service proxying](https://go.cpanel.net/ServiceProxying).

**Note:**

* If the [Web Server](https://go.cpanel.net/howtouseserverprofiles#roles) 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.

## Query parameters

- `general` union
  - string, hostname — A valid hostname.
  - string, ipv4 — A valid IP address.
- `service_group` 'Mail'
- `service_group_backend` union
  - string, hostname — A valid hostname.
  - string, ipv4 — A valid IP address.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object, nullable
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)