[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
Destroy Replication
DescriptionDelete replication of a VM. The operation deletes the replication only on the local site. Remove the replication configuration first.
Request
URLURL
https://{api_host}//pairings/{pairing_id}/replications/{replication_id}
Path Parameters
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
Query Parameters
boolean
retain_replica_disks
Optional
Whether or not to retain replica disks.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
TaskDrResponseEntity
of type application/json
Task to monitor destroying a replication
{
"_meta": {
"errors": [
{
"code": "string",
"field": "string",
"message": "string"
}
]
},
"complete_time": "string",
"description": "string",
"description_id": "string",
"entity": "string",
"entity_name": "string",
"error": {
"details": "string",
"message": "string"
},
"id": "string",
"progress": 0,
"queued_time": "string",
"result": {},
"start_time": "string",
"status": "QUEUED"
}
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
PowerCLI Client SDK Example
Invoke-VrDestroyReplication -pairingId "MypairingId" -replicationId "MyreplicationId" -retainReplicaDisks $true
cURL Command
curl -X DELETE https://{api_host}/pairings/{pairing_id}/replications/{replication_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
permissions:
- System.View
- Host.Hbr.HbrManagement
x-dr-remote-site-connectivity-contract:
not-authenticated: OK
server-down: OK
[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
vsphere-replication-api
On This Page
Replication Operations
post
delete
get
post
post
post
post
