REST API Changelog

In this article

    This section describes the latest changes and features introduced in the Orchestrator REST API v5.

    Breaking Changes

    The changes introduced in the Orchestrator REST API v5 cause an issue in the REST API v3: the GET request to the /api/v3/Plans endpoint fails with the 500 server error. To get a collection of plans, use the /api/v4/Plans or /api/v5/Plans endpoint.

    Resource Changes

    The following changes in the REST API schemas were made:

    • StepInfo schema:
    • Added the prohibitedOperations property.
    • RecoveryGroupInfo schema:
    • Added the groupCategory property.
    • PlanRuntimeDetails schema:
    • Added the planMode, planVerificationState, vendor, isUndoPossible, isReversePossible properties.
    • Deleted the data.serverId property.
    • GroupRuntimeDetails schema:
    • Added the groupCategory and virtualGroupType properties.
    • Deleted the data.serverId property.
    • Added the ResponseWrapper[Object] schema, that includes the success and data properties.
    • VmRuntimeDetails schema:
    • Added the voId property.

    New Resources

    The following new operations were added to the existing resource collections in the Orchestrator REST API v5:

    • POST /api/v5/Plans/{planId}/Clone — Clone Plan
    • POST /api/v5/Plans/{planId}/PrepareToFailback — Prepare for Failback
    • POST /api/v5/Plans/{planId}/SwitchoverToProduction — Switchover to Production

    Deprecated Resources

    The following endpoints are deprecated in the Orchestrator REST API v5:

    • GET /api/v5/Sites — Get VAO Server Data
    • GET /api/v5/Sites/{siteId}/Scopes — Get Collection of Scopes on VAO Server