- URL:
- https://<root>/logs/settings
- Methods:
GET- Operations:
- Edit Settings, Update Log Index
- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The settings resource returns the current log settings for an organization. At ArcGIS Enterprise 11.2 on Kubernetes, this resource returns the maximum number of days logs are retained in the system before they are deleted (max). At ArcGIS Enterprise 11.5 on Kubernetes, this resource also returns the maximum number of error (crash) reports that can be saved in your system (max). If the number of generated error reports exceeds the maximum value, the oldest report is deleted to create space for the newly generated report.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the settings resource:
https://organization.example.com/<context>/admin/logs/settings?f=pjsonJSON Response syntax
{
"maxLogAgeDays": <Number of days for the log retention policy>,
"logLevel": "<INFO | SEVERE | WARNING | FINE | VERBOSE | DEBUG>",
"lastModified": <Milliseconds from epoch from when log settings were last updated>,
"maxErrorReportsCount": <Maximum number of error reports that can be saved in your system>
}JSON Response example
{
"maxLogAgeDays": 60,
"logLevel": "INFO",
"lastModified": 1597076095038,
"maxErrorReportsCount": 10
}