Skip To Content
ArcGIS Developers
Dashboard

Backup (Create)

Description

This operation creates a backup that can then be restored in the event of data loss, data corruption, or deployment failures. The backup will be stored in the backup store that is set when creating the backup.

Request parameters

ParameterDetails
name

(Required)

The name of the backup.

Example

name=backup
storeName

(Required)

The backup store that the backup will be copied to.

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.

description

(Optional)

A description of the backup.

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

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

POST /context/admin/system/disasterrecovery/backuprestore/backup HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

name=backup&storeName=backupsDefault&passcode=passcode&description=&f=pjson&token=HRozb6bnTL6gfA-SJO-IxhfLgJrioK1KJdMLWmCE5HjHWz9U3fOiFv3-HkgPZqsLljTkk2WDENGt5fjho5s39e_mZL5At60UvJPoNnC5O2sv2HTlumG7TsYfbtnokpWmS6-lf8XoQpSKusZwmxIkEMP-yE0Wxrj8o9sWKi29J-pxzkoCDhoUfdLt6NnBWxhESpegh8BzNcEruqxuDQD-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1e

JSON Response example

{
  "status": {
    "code": 0,
    "messages": [],
    "state": "in_progress"
  }
}