NginxCaching

4 functions, invoked through the cpanel_uapi tool.

Enable, disable, clear, or reset the account's Nginx reverse-proxy cache

scope cpanel:uapifiles

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

clear_cache GET mutating#

Delete NGINX cache contents.

This function clears the user's NGINX cache.

Note:

You can only use this function if you installed the ea-nginx package.

No parameters.

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

Payload varies by call.

disable_cache GET mutating#

Disable the user's NGINX cache

This function disables the user's NGINX cache.

Note:

You can only use this function if you installed the ea-nginx package.

No parameters.

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

Payload varies by call.

enable_cache GET mutating#

Enable the user's NGINX cache

This function enables the user's NGINX cache.

Note:

You can only use this function if you installed the ea-nginx package.

No parameters.

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

Payload varies by call.

reset_cache_config GET mutating#

Reset the user's NGINX cache configuration

This function resets the user's NGINX caching configuration.

Note:

You can only use this function if you installed the ea-nginx package.

No parameters.

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

Payload varies by call.