IBM DataPower Operations Dashboard v1.0.6.0

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

User will need an admin or operator access for this API, Unauthorized users will get "401 Unauthorized"

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
{
"resultCode": "SUCCESS",
"resultErrorCode": "SUCCESS",
"resultMessage": "Backup plan added to execution queue"
}

Error:

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


This API does NOT execute the plan, it just adds it to the execution queue, the plan may not execute if, for example, it the current time is not within the plan's maintenance window timeframe


  • No labels