Returns weblog analyzers' configuration

This function lists the configuration of the web log anayzers for each domain on the cPanel account.

Important:

When you disable the WebServer role the system disables this function. For more information, read our How to Use Server Profiles documentation.

Note

Additional web log analyzer configuration such as if the user can edit their own configuration is provided in the metadata section of the return.

Authorizations:

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

Request samples

uapi --output=jsonpretty \
  --user=username \
  StatsManager \
  get_configuration

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_configuration",
  • "module": "StatsManager",
  • "result": {
    • "data": [
      • {
        • "analyzers": [
          • {
            • "enabled": 1,
            • "enabled_by_user": 1,
            • "name": "awstats"
            },
          • {
            • "enabled": 0,
            • "enabled_by_user": 0,
            • "name": "analog"
            },
          • {
            • "enabled": 0,
            • "enabled_by_user": 1,
            • "name": "webalizer"
            }
          ],
        • "domain": "domain.com"
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "analyzers": [
        • {
          • "available_for_user": 1,
          • "enabled_by_default": 0,
          • "name": "analog"
          },
        • {
          • "available_for_user": 1,
          • "enabled_by_default": 1,
          • "name": "awstats"
          },
        • {
          • "available_for_user": 1,
          • "enabled_by_default": 0,
          • "name": "webalizer"
          }
        ],
      • "locked": 1,
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}