latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

NGINX Manager

Return user NGINX caching configurations.

This function returns a user's NGINX cache configuration.

get/nginxmanager_get_cache_config_users

Query parameters

merge1
Example:1

Combine default, system, and user NGINX configurations when returning configuration data.

Note:

  • 1 - Return the configuration with default, system, and user values combined.
userstring[]

A list of users whose cache configuration you want to retrieve.

Note:

If you do not pass this parameter, this function retrieves the cache configuration for all users.

[
  "unclebob",
  "auntsue"
]

Response

HTTP Request was successful.

Example response

{
  "data": {
    "users": [
      {
        "config": {
          "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": false,
          "zone_size": "10m"
        },
        "merged": 0,
        "owner": "root",
        "user": "cptest1"
      },
      {
        "config": {
          "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": false,
          "zone_size": "10m"
        },
        "merged": 0,
        "owner": "root",
        "user": "cptest2"
      }
    ]
  },
  "metadata": {
    "command": "nginxmanager_set_config",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}