- URL:
- https://<root>/system/disasterrecovery/stores/<storeName>/backups/create
- Methods:
POST- Required Capability:
- Access allowed with the "Security and infrastructure" privilege
- 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 jobs property. The value returned for jobs can be used to access the job resource to track the job's status. For more information, see the Job resource topic.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The name of the backup. Example |
(Required) | The name of the backup store where the backup will be stored. Example |
(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. |
(Optional) | A description of the backup. |
(Optional) | Introduced at 10.9.1. The date, in epoch milliseconds, when the backup will be eligible for cleanup by a system task. Example |
| The response format. The default format is Values: |
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-JRmaTsbRDaBHTQTePMzQePhXl7KcEG9Cfkw2sa7P1W1eJSON Response example
{
"jobsUrl": "https://organization.domain.com/context/admin/jobs/j7d22f855-2c9f-4934-94e4-93c5e85cd271",
"jobid": "j7d22f855-2c9f-4934-94e4-93c5e85cd271",
"status": "SUBMITTED"
}