Run Test Recovery

Run Test Recovery

Run a test recovery for this recovery plan, leaving the primary site unaffected.

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

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

string
plan_id
Required

The ID of a recovery plan defined within current pairing


Request Body

Spec describing test recovery settings

TestPlanSpec of type(s) application/json
Required
{
    "sync_data": false
}
boolean
sync_data
Optional

Whether to call the replication providers to synchronize the outstanding data before the operation

Authentication
This operation uses the following authentication methods.
Responses
202

A task to monitor the operation progress.

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