cPanel module

ServiceProxy

3 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi

Call any function with cpanel_uapi(service_id, module="ServiceProxy", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get_service_proxy_backends GET#

Return a cPanel account’s service proxying setup

This function reports a cPanel account's service proxying configuration.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

backendstring

The name of the server to which the system will proxy requests for this service group.

service_groupstring

The name of the proxying service group, if applicable. * null — The account’s general service proxying backend.

set_service_proxy_backends GET#

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.

generalmixedOptional

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_groupstringOptional

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.

service_group_backendmixedOptional

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.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.

unset_all_service_proxy_backends GET#

Remove cPanel account service proxying

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.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

Payload varies by call.