Update NGINX caching status.

This function enables or disables NGINX caching.

Authorizations:
query Parameters
enabled
required
integer
Enum: 1 0
Example: enabled=1

Whether to enable to disable caching.

Note:

  • 1 - Enables caching.
  • 0 - Disables caching.
user
Array of strings <username>
Default: []
Example: user=unclebob&user=auntsue

A list of users whose caching you want to enable or disable.

Note:

If you do not pass this parameter, this function sets the caching status for all users on the system.

Responses

Response Schema: application/json
object

Request samples

whmapi1 nginxmanager_set_cache_config enabled='1'

Response samples

Content type
application/json
{
  • "metadata": {
    • "command": "nginxmanager_set_cache_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}