Destroy Replication

Destroy Replication

Delete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.

Request
URI
DELETE
https://{api_host}/pairings/{pairing_id}/replications/{replication_id}
COPY
Path Parameters
string
pairing_id
Required

The ID of the pairing between this vSphere Replication server and the remote one.

string
replication_id
Required

The ID of a replication

Query Parameters
boolean
retain_replica_disks
Optional

Whether or not to retain replica disks.

Authentication
This operation uses the following authentication methods.
Responses
202

Task to monitor destroying a replication

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"
            }
        ]
    }
}
Metadata
_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


On This Page
Replication Operations
POST
Browse Datastore
POST
Check Storage Policy Compliance
POST
Configure Replication
DELETE
Destroy Replication
GET
Get All Replications
GET
Get Local Vm Disks
GET
Get Local Vms
GET
Get Replicated Vm Disks
GET
Get Replication Info
GET
Get Replications Count
GET
Get Replications Issues
POST
Get Seeds For Disks
GET
Get Vc Storage Policies
GET
Get Vm Capability
GET
Get Vr Capable Target Datastores
POST
Pause Replication
POST
Reconfigure Replication
POST
Resume Replication
POST
Sync Replication
POST
Unconfigure Replication