Backup Restore Information

URL:
https://<root>/backupRestoreInfo
Methods:
GET
Required Capability:
Access allowed with any authorized privilege
Version Introduced:
11.0

Description

The backupRestoreInfo 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

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Response properties

PropertyDetails

fullBackupTimeStamp

The date-time information (Unix) of the last full backup of the organization.

fullRestoreTimeStamp

The date-time information (Unix) of the last full restore for the organization.

incrementalBackupTimeStamp

The date-time information (Unix) of the last incremental backup of the organization.

incrementalRestoreTimeStamp

The date-time information (Unix) of the last incremental restore for the organization.

backupModeTimeStamp

The date-time information (Unix) of the last backup performed in BACKUP mode for the organization.

backupMode

The backup type for the last backup that was created.

Values: FULL | INCREMENTAL | BACKUP

failOver

A binary value specifying whether the portal has failed over recently.

Values: true | false

backupModeTimeStamp

Introduced at ArcGIS Enterprise 11.1. The date-time information (Unix) of the last backup of the organization when using backup mode.

incrementalBackupEnabled

A binary value specifying whether the option for the portal to create transaction logs when an incremental backup is performed is enabled.

Values: true | false

Example usage

The following is a sample request URL used to access the backupRestoreInfo resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/portaladmin/backupRestoreInfo?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "fullBackupTimeStamp": 0,
  "fullRestoreTimeStamp": 0,
  "incrementalBackupTimeStamp": 0,
  "incrementalRestoreTimeStamp": 0,
  "backupModeTimeStamp": 1663189339611,
  "backupMode": "BACKUP",
  "incrementalBackupEnabled": false
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.