[{"label":"Latest (1.0.0)","version":"latest"}]
srm-rest-api

Cancel Recovery Plan

Description

Cancels a running recovery task for this recovery plan.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/cancel
Copy

Path Parameters

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


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

204 No Content

Recovery successfully cancelled.

Errors

Errors

ResponseError
400

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


401

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


ResponseError
403

Forbidden - not sufficient access rights to fulfill the request


404

Not Found - server cannot find the requested in URL resource


ResponseError
500

Internal server error - unexpected condition prevents fulfilling the request

Code Samples

Code Samples

cURL Command

curl -X POST https://{api_host}/pairings/{pairing_id}/recovery-management/plans/{plan_id}/actions/cancel
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - VcDr.RecoveryProfile.com.vmware.vcDr.Failover
        - VcDr.RecoveryProfile.com.vmware.vcDr.Run
x-dr-remote-site-connectivity-contract:
    not-authenticated: ERROR
    server-down: DEPENDS_ON_PROVIDED_PARAMS


Feedback

Was this page helpful?