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"
}
| Info |
|---|
| 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) |