Create Plan

Create Plan

Create a new recovery plan in a given pairing.

Request
URI
POST
https://{api_host}/pairings/{pairing_id}/recovery-management/plans
COPY
Path Parameters
string
pairing_id
Required

The ID of a pairing between this Site Recovery Manager server and remote one


Request Body

A spec describing the new plan.

RecoveryPlanCreateSpec of type(s) application/json
Required
{
    "location": "string",
    "name": "string",
    "description": "string",
    "protected_vc_guid": "string",
    "protection_groups": [
        "string"
    ],
    "test_network_mappings": [
        {
            "target_network": "string",
            "test_network": "string"
        }
    ]
}
string
location
Optional

Target location where the recovery plan will be placed. If not specified - the root folder will be used.

string
name
Required

Name of the recovery plan

string
description
Optional

Description of the recovery plan.

string As uuid As uuid
protected_vc_guid
Required

GUID of the protected site VC.

array of string
protection_groups
Optional

A list of protection groups to be added to the recovery plan.

test_network_mappings
Optional

A list of test network mappings to be added to the recovery plan.

Authentication
This operation uses the following authentication methods.
Responses
202

Recovery plan creation task

Returns TaskDrResponseEntity of type(s) application/json
This response body class contains all of the following: Task
{
    "id": "string",
    "description": "string",
    "description_id": "string",
    "entity": "string",
    "entity_name": "string",
    "status": "string",
    "error": {
        "message": "string",
        "details": "string"
    },
    "progress": 0,
    "queued_time": "string",
    "start_time": "string",
    "complete_time": "string",
    "_meta": {
        "errors": [
            {
                "code": "string",
                "message": "string",
                "field": "string"
            }
        ]
    }
}
_meta
Optional

_meta


400

Bad request - the server could not understand the request due to invalid syntax or invalid request body content

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


401

Unauthorized - the client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

Forbidden - not sufficient access rights to fulfill the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id


404

Not Found - server cannot find the requested in URL resource

Operation doesn't return any data structure

500

Internal server error - unexpected condition prevents fulfilling the request

Returns ResponseError of type(s) application/json
{
    "error_code": "string",
    "message": "string",
    "op_id": "string"
}
string
error_code
Optional

error_code

string
message
Optional

message

string As uuid As uuid
op_id
Optional

op_id