The REST API provides the following methods for managing backup schedules and backup restores:
PUT /api/backup/schedules
| URI | PUT /api/backup/schedules |
|---|---|
| Description | Creates a new backup schedule. |
| Request Header |
|
|
|
| Request Body |
{
"backupAreas":["ALL"],
"directory": "test",
"cronExpression": "0 0 * * * ?",
"backupType": "INCREMENTAL"
}
|
| Response Status | 200 OK - operation successful. |
| Response Body | Empty. |
| Access Rights | 'Manage backups REST API'. |
GET /api/backup/schedules
URI |
|
| Description | Get a list of all backup schedules. |
| Request Header |
|
Accepts: application/vnd.orchestral.rhapsody.6_2+json |
|
| Request Body | Empty. |
| Response Status | 200 OK - operation successful. |
| Response Body |
{
"data":[{
"id":1,
"backupAreas":["ALL"],
"directory":"C\u003A\u005CDev",
"cronExpression":"0\u00200\u0020\u002A\u0020\u002A\u0020\u002A\u0020\u003F",
"backupType":"FULL",
"timestamp":1444096806360
}],
"error":null
}
|
| Access Rights | 'Get backup information REST API'. |
GET /api/backup/schedules/<id>
| URI | GET /api/backup/schedules/<id> |
|---|---|
| Description | Gets the status of a specific backup schedule. |
| Request Header | Accept: application/json |
Accept: text/vnd.orchestral.rhapsody.6_3+plain |
|
Accept: application/vnd.orchestral.rhapsody.6_4+json |
|
| Request Body | Empty.
|
| Response Status | 200 OK - operation successful. |
| Response Body |
{
"data": {
"id": 1,
"backupAreas": [
"ALL"
],
"directory": "c:/output",
"cronExpression": "0 0 * * * ?",
"backupType": "INCREMENTAL",
"currentStatus": "NOT_RUNNING",
"lastRunResult": "SUCCEEDED",
"lastRunCompletedTime": "20180515T160000.937+1200",
"lastRunTimeTaken": "PT0.848S"
},
"error": null
}
|
| Access Rights | 'Get backup information REST API'. |
POST /api/backup/schedules/<id>
| URI | POST /api/backup/schedules/<id> |
|---|---|
| Description | Sets the status of a backup schedule, start or stop the schedule. |
| Request Header | Content-Type: text/plain CSRF Protection Enabled |
|
|
| Request Body | START or STOP. |
| Response Status | 204 No Content - operation successful. |
| Response Body | Empty. |
| Access Rights | 'Manage backups REST API'. |
DELETE /api/backup/schedules/<id>
| URI | DELETE /api/backup/schedules/<id> |
|---|---|
| Description | Deletes a backup schedule. |
| Request Header | CSRF Protection Enabled |
| Request Body | Empty. |
| Response Status | 204 No Content - operation successful. |
| Response Body | Empty. |
| Access Rights | 'Manage backups REST API'. |
POST /api/backup/restore
| URI | POST /api/backup/restore |
|---|---|
| Description | Performs a restore operation. |
| Request Header | Content-Type: application/json CSRF Protection Enabled |
|
|
| Request Body |
{
"restoreAreas" : ["ALL"],
"directory":"qwerty",
"forensicRestore": true
}
|
| Response Status | 204 No Content - operation successful. |
| Response Body | Empty. |
| Access Rights | 'Manage backups REST API'. |