Appliance Backup REST API

Prerequisites

Requires admin or operator access.
Unauthorized requests will receive a "401 Unauthorized" response.

Send a backup plan to the execution queue:

POST /op/api/v1/backupplan/<API-Reference>/execute

The API-Reference of the plan is set in the add/edit plan page, and can be viewed in the plan details page

Successful Response

{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Backup plan added to execution queue"
}

Error Response

{
"resultCode": "ERROR",
"resultErrorCode": "PLAN_NOT_FOUND",
"resultMessage": "Backup Plan with API Ref 199da450-7add-42fd-b644-986cfc018f32 was not found"
}

This API call does NOT execute the plan, it just adds it to the execution queue.
The plan may not be executed at all. (For example - when the current time is not within the plan's maintenance window timeframe, or if the plan is not enabled)

Get All Available Plans

GET /op/api/v1/backupplan/

The lastUpdateTime field returns the last time the plan was updated in epoch time format.

{
"plans": [
{
"name": "backup-QA",
"description": "Backup all QA Devices on Sundays",
"URI": "/op/api/v1/backupplan/199da450-7add-42fd-b644-986cfc018f31",
"lastUpdateTime": 1513582431660
},
{
"name": "backup-Prod",
"description": "Backup all PROD Devices daily",
"URI": "/op/api/v1/backupplan/199da450-7add-42fd-b644-986cfc018f31",
"lastUpdateTime": 1513582431660
}
]
}