Edit Log Settings

URL:: https://<root>/logs/settings/edit
Methods:: POST
Required Capability:: Access allowed with the "Security and Infrastructure" privilege
Version Introduced:: 10.1

Description

The edit operation updates the logs settings for the entire server site.

Request parameters

Parameter	Details
`logLevel`	The highest level of detail at which logs will be recording. The default is `WARNING`. Values: `OFF` \| `SEVERE` \| `WARNING` \| `INFO` \| `FINE` \| `VERBOSE` \| `DEBUG`
`logDir`	File path to the root of the log directories. The default path for Windows is `C:\\arcgisserver\\logs` and for Linux is `[server root]/usr/logs`. Example Use dark colors for code blocksCopy `1 logDir=/data/ags/arcgis/server/usr/logs`
`maxLogFileAge`	Represents the number of days that server should save a log file. The default value is 90. Example Use dark colors for code blocksCopy `1 maxLogFileAge=90`
`maxErrorReportsCount`	The maximum number of error report files per machine. The default value is 10. Example Use dark colors for code blocksCopy `1 maxErrorReportsCount=10`
`f`	The response format: The default value is `html`. Values: `html` \| `json` \| `pjson`

Example usage

The following is a sample POST request for the edit operation:

Use dark colors for code blocksCopy
POST /webadaptor/admin/logs/settings/edit HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

logLevel=INFO&logDir=/data/ags/arcgis/server/usr/logs&maxLogFileAge=90&maxErrorReportsCount=10&f=pjson

JSON Request example

Use dark colors for code blocksCopy
{
  "settings": {
   "logDir": "/data/ags/arcgis/server/usr/logs/",
   "logLevel": "INFO",
   "maxLogFileAge": 90,
   "maxErrorReportsCount": 10
  }
}

JSON Response example

Use dark colors for code blocksCopy
{
  "status": "success",
  "settings": {
    "logDir": "/data/ags/arcgis/server/usr/logs/",
    "logLevel": "INFO",
    "maxLogFileAge": 90,
    "maxErrorReportsCount": 1
  }
}