- URL:
- https://<root>/system/database/settings
- Methods:
GET- Operations:
- Edit Database Settings
- Version Introduced:
- 10.9
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 settings resource returns whether incremental backups have been enabled or disabled for your organization. If enabled (true), the Edit operation can be used to disable (false) incremental backups. The edit operation cannot, however, be used to enable incremental backups. For information on how to enable this property using the webgisdr utility, see Create an ArcGIS Enterprise backup and Configure disaster recovery for ArcGIS Enterprise.
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>/portaladmin/system/database/settings?f=pjsonJSON Response syntax
{"incrementalBackupEnabled": <true|false>}JSON Response example
{"incrementalBackupEnabled": false}