Create a backup

After registering the staging location and a backup store, you can create backups using ArcGIS Enterprise Administrator API. It is recommended that you create backups during downtime to ensure that the additional requests for resources do not cause issues for users accessing the deployment.

Create a backup

To create a backup, complete the following steps:

  1. Sign in to ArcGIS Enterprise Administrator API as an administrator of your organization.
  2. Click System > Disaster Recovery > Backup and Restore.
  3. Click Create Backup.
  4. Set the following parameters:
    1. Backup Name—Provide the name of the backup.
    2. Backup Store Name—Provide the name of the backup store.
    3. Passcode—Provide the passcode that will be used when restoring the backup.
      Note:

      The backup cannot be restored without the passcode.

    4. Description—Provide a description of the backup.

When the backup operation begins, the backup store is spun up to store the backup. A job and an additional pod start and coordinate the backup process. The amount of time it takes to create the backup is based on the number of items in the deployment. By default, backup operations that take longer than 2 hours to complete are automatically canceled. If a deployment contains a large amount of data and takes longer than 2 hours to back up, you can change the backup operation's time-out value in the Disaster Recovery settings.

Change the time-out value

To change the time-out value, complete the following steps:

  1. Sign in to ArcGIS Enterprise Administrator API as an administrator of your organization.
  2. Click System > Disaster Recovery > Settings.
  3. Click Update Settings.
  4. Update the JSON in the Settings text box to include the timeoutInSeconds property.
    { 
        "timeoutInSeconds": 10800, 
        "stagingVolumeConfig": { 
            "provisioningType":"DYNAMIC", 
            "storageClass": "staging", 
            "size": "64Gi"		 
        } 
    }
    

Check the status of a backup

To check the status of an ongoing or recent backup operation, use the Get Status API available in ArcGIS Enterprise Administrator API.

To access the Get Status API, complete the following steps:

  1. Sign in to ArcGIS Enterprise Administrator API as an administrator of your organization.
  2. Click System > Disaster Recovery > Backup and Restore.
  3. Click Get Status.

The API returns the current state of the backup operation. You can monitor the page during a backup to track its progress.