- URL:
- https://<root>/backupRestoreInfo
- Methods:
GET- Version Introduced:
- 11.0
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 backup resource displays the backup and restore information for an organization, such as when the last full or incremental backups were performed, as well as when the last full or incremental restores were performed, using the webgisdr utility. Starting at ArcGIS Enterprise 11.1, this resource also returns the date and time the last backup was performed in backup mode. For more information about these modes, see ArcGIS Enterprise backups.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The date-time information (Unix) of the last full backup of the organization. |
| The date-time information (Unix) of the last full restore for the organization. |
| The date-time information (Unix) of the last incremental backup of the organization. |
| The date-time information (Unix) of the last incremental restore for the organization. |
| The date-time information (Unix) of the last backup performed in |
| The backup type for the last backup that was created. Values: |
| A binary value specifying whether the portal has failed over recently. Values: |
| Introduced at ArcGIS Enterprise 11.1. The date-time information (Unix) of the last backup of the organization when using backup mode. |
| A binary value specifying whether the option for the portal to create transaction logs when an incremental backup is performed is enabled. Values: |
Example usage
The following is a sample request URL used to access the backup resource:
https://organization.example.com/<context>/portaladmin/backupRestoreInfo?f=pjsonJSON Response example
{
"fullBackupTimeStamp": 0,
"fullRestoreTimeStamp": 0,
"incrementalBackupTimeStamp": 0,
"incrementalRestoreTimeStamp": 0,
"backupModeTimeStamp": 1663189339611,
"backupMode": "BACKUP",
"incrementalBackupEnabled": false
}