IBM DataPower Operations Dashboard v1.0.8.5
Note: A more recent version of DPOD is available. See IBM DPOD Documentation for the latest documentation.
Appliance Configuration Sync REST API
Prerequisites
Requires admin or operator access.
Unauthorized requests will receive a "401 Unauthorized" response.
Send a sync plan to the execution queue:
POST /op/api/v1/syncplan/<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": "Sync plan added to execution queue"
}
Error Response
{
"resultCode": "ERROR",
"resultErrorCode": "PLAN_NOT_FOUND",
"resultMessage": "Sync Plan with API Ref 199da450-7add-42fd-b644-986cfc018f32 was not found"
}
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/syncplan/
The lastUpdateTime field returns the last time the plan was updated in epoch time format.
{
"plans": [
{
"name": "SyncPlan1",
"description": "Sync from QA1 to QA2 and QA3",
"URI": "/op/api/v1/syncplan/6f56fa33-e201-47cb-aad5-be86d663e976",
"lastUpdateTime": 1513583061224
},
{
"name": "SyncPlan2",
"description": "",
"URI": "/op/api/v1/syncplan/d73d875c-adff-4cb3-90ab-7680b9662693",
"lastUpdateTime": 1505730217117
}
]
}