Skip To Content
ArcGIS Developer
Dashboard

Create Backup

  • URL:ArcGIS Enterprise on Kubernetes 10.9.1 and later URL:
    https://<root>/system/disasterrecovery/stores/<storeName>/backups/create (POST Only)

    ArcGIS Enterprise on Kubernetes 10.9 URL:
    https://<root>/system/disasterrecovery/backuprestore/backup (POST Only)
  • Required Capability:Default administrator role | Security and infrastructure
  • Version Introduced:10.9

Description

The create operation creates a backup that can be restored in the event of data loss, data corruption, or deployment failures. Backups are stored in a designated backup store. The response returns a JSON object containing job information, including a jobsUrl property. The value returned for jobsUrl can be used to access the job resource to track the job's status. For more information, see the Job resource topic.

Request parameters

ParameterDetails
name

(Required)

The name of the backup.

Example

name=backup
storeName

(Required)

Legacy:

This parameter has been deprecated with the release of ArcGIS Enterprise on Kubernetes 10.9.1.

The name of the backup store where the backup will be stored.

Example

storeName=backupsDefault
passcode

(Required)

A passcode that will be used to encrypt the content of the backup. When restoring a backup, this passcode must be passed in. The passcode must be at least eight characters in length.

description

(Optional)

A description of the backup.

retentionDate

(Optional)

Introduced at 10.9.1. The date, in epoch milliseconds, when the backup will be eligible for cleanup by a system task.

Note:

Assigning a value of -1 to retentionDate will cause the backup to never expire, meaning that it will never be cleaned by the backupRetentionCleaner task. Not assigning a value to this parameter will automatically set the retentionDate value to -1.

Example

retentionDate=1635945710988
f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the create operation:

POST /context/admin/system/disasterrecovery/stores/<storeName>/backups/create HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=backup_first&passcode=passcode&description=&retentionDate=1635945710988&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e

JSON Response example

{
  "jobsUrl": "https://organization.domain.com/context/admin/jobs/j7d22f855-2c9f-4934-94e4-93c5e85cd271",
  "jobid": "j7d22f855-2c9f-4934-94e4-93c5e85cd271",
  "status": "SUBMITTED"
}