Operations and Methods

The following method-implemented operations are supported for the /Plans collection in the VAO REST API:

• (GET)/api/v3/Plans — retrieves /Plans collection representation.
• (GET)/api/v3/Plans/{planId} — retrieves /Plans/{planId} resource representation.
• (GET)/api/v3/Plans/{planId}/Groups — retrieves /Groups collection representation for a plan.
• (GET)/api/v3/Plans/{planId}/Groups/{groupId}/Vms — retrieves /Group/{groupId}/Vms collection representation for a VM group in a plan.
• (GET)/api/v3/Plans/{planId}/Groups/{groupId}/Steps — retrieves /Group/{groupId}/Steps collection representation for a virtual group in a plan.
• (GET)/api/v3/Plans/{planId}/Vms/{vmId}/Steps — retrieves /Vms/{vmId}/Steps collection representation for a VM in a plan.
• (GET)/api/v3/Plans/{planId}/Steps/{stepId}/Parameters — retrieves /Steps/{stepId}/Parameters collection representation for a step in a plan.
• (POST)/api/v3/Plans/{planId}/ReadinessCheck — starts a readiness check for the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Enable — enables the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Disable — disables the /Plans/{planId} plan.
• (PUT)/api/v3/Plans/{planId}/Schedule/SaveTime — configures a schedule for the /Plans/{planId} plan to run at a specific time.
• (PUT)/api/v3/Plans/{planId}/Schedule/SaveRunAfter — configures a schedule for the /Plans/{planId} plan to run after another plan.
• (DELETE)/api/v3/Plans/{planId}/Schedule — disables a configured schedule for the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Halt —  interrupts the plan execution process for the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Continue —  continues the plan execution process for the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/ResetState — resets the current state of the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/ResetChangeLog — clears the change log history for the /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Failover — starts the failover process for the replica or storage /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/PermanentFailover — starts the permanent failover process for the replica /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/FailBackToProduction — starts the failback process for the replica /Plans/{planId} plan.

• (POST)/api/v3/Plans/{planId}/CommitFailback — starts the commit failback process for the replica /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Undo — undo all previous operations for the replica or storage /Plans/{planId} plan.
• (POST)/api/v3/Plans/{planId}/Restore — starts the restore process for the restore /Plans/{planId} plan.