Return NGINX caching configurations.

This function returns the system NGINX cache configuration.

SecurityBasicAuth
Request
query Parameters
merge
integer

Whether to combine the default and system NGINX configurations when returning configuration data.

Note:

  • 1 - Return the configuration with default and system values combined.
Value: 1
Example: merge=1
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/nginxmanager_get_cache_config_system
Request samples
whmapi1 --output=jsonpretty \
  nginxmanager_get_cache_config_system
Response samples
application/json
{
  • "data": {
    • "default": {
      • "enabled": 1,
      • "inactive_time": "60m",
      • "levels": 62,
      • "logging": 0,
      • "proxy_cache_background_update": "on",
      • "proxy_cache_lock": "on",
      • "proxy_cache_min_uses": 1,
      • "proxy_cache_revalidate": "on",
      • "proxy_cache_use_stale": "error timeout http_429 http_500 http_502 http_503 http_504",
      • "x_cache_header": 0,
      • "zone_size": "10m"
      },
    • "system": {
      • "enabled": true,
      • "inactive_time": "60m",
      • "levels": 62,
      • "logging": false,
      • "proxy_cache_background_update": "on",
      • "proxy_cache_lock": "on",
      • "proxy_cache_min_uses": 1,
      • "proxy_cache_revalidate": "on",
      • "proxy_cache_use_stale": "error timeout http_429 http_500 http_502 http_503 http_504",
      • "x_cache_header": 0,
      • "zone_size": "10m"
      }
    },
  • "metadata": {
    • "command": "nginxmanager_set_config",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}