- URL:
- https://<root>/logs/settings/edit
- Methods:
POST- 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 edit operation updates the log level, the log retention policy (introduced at 11.2), and the maximum number of error (crash) reports that can be stored (introduced at 11.5) for an ArcGIS Enterprise on Kubernetes deployment.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The highest level of detail at which logs will be recording. The default is Values: |
(Required) | Introduced at 11.2. Sets the log retention policy for an ArcGIS Enterprise on Kubernetes deployment. The value represents the maximum number of days the system will retain the logs before they are deleted. The default value for this parameter is Example |
(Optional) | Introduced at 11.5. Sets the maximum number of error (crash) reports that can be stored at a given time. If the number of crash reports exceeds this number, the oldest error report is deleted to create space for the newly generated error report. The default value for this parameter is Example |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the edit operation:
POST /<context>/admin/logs/settings/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
logLevel=SEVERE&maxLogAgeDays=45&maxErrorReportsCount=15&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
{"success": "true"}