CPcpanel
NGINX Manager

Update NGINX caching status.

This function enables or disables NGINX caching.

get/nginxmanager_set_cache_config

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

enabled1 | 0 required
Example:1

Whether to enable to disable caching.

Note:

  • 1 - Enables caching.
  • 0 - Disables caching.
userstring[]

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.

[
  "unclebob",
  "auntsue"
]

Response

HTTP Request was successful.

Example response

{
  "metadata": {
    "command": "nginxmanager_set_cache_config",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.