UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/get_service_proxy_backends
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ServiceProxy/get_service_proxy_backends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/get_service_proxy_backendsResponse
application/json
{ "apiversion": 3, "func": "get_service_proxy_backends", "module": "ServiceProxy", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
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_backendsfunction.
Security
BasicAuth
Query
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.
Any of:
A valid hostname.
string(hostname)
A valid hostname.
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_backendvalue. - To add multiple
service_groupvalues, increment the parameter name. For example,service_group,service_group-1, andservice_group-2.
Value"Mail"
Examples: service_group=Mail&service-group-1=Mail&service-group-2=Mail
service_group=Mail
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_groupvalue. - To add multiple
service_group_backendvalues, increment the parameter name. For example,service_group_backend,service_group_backend-1, andservice_group_backend-2.
service_group_backend=mail.example.com&service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com
service_group_backend=mail.example.com
Any of:
A valid hostname.
string(hostname)
A valid hostname.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/set_service_proxy_backends
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ServiceProxy/set_service_proxy_backends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/set_service_proxy_backends?general=hostname.example.com&service_group=Mail&service_group_backend=hostname.example.com'Response
application/json
{ "apiversion": 3, "func": "set_service_proxy_backends", "module": "ServiceProxy", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
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_backendsfunction.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/unset_all_service_proxy_backends
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ServiceProxy/unset_all_service_proxy_backends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ServiceProxy/unset_all_service_proxy_backendsResponse
application/json
{ "apiversion": 3, "func": "unset_all_service_proxy_backends", "module": "ServiceProxy", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }