- URL:
- https://<root>/logs/settings/edit
- Methods:
POST- Version Introduced:
- 10.3.1
Access requirements
Required privileges
The Portal 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 Portal 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 Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.
Description
The edit operation updates the log settings for the portal.
Request parameters
| Parameter | Details |
|---|---|
| File path to the root of the log directories. The default for Windows is Example Example |
| The highest level of detail at which logs will be recording. The default is Values: |
| By default, logs are retained on disk for a period of approximately 90 days. When a log exceeds this time frame, it is deleted. Specifying a smaller time frame, for example, Example |
| The response format: The default is Values: |
Example usage
The following is a sample POST request for the edit operation:
POST /<context>/portaladmin/logs/settings/edit HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
logDir=C:\arcgisportal\logs&logLevel=WARNING&maxLogFileAge=90&f=jsonJSON Request example
{"status": "success"}