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

Unconfigure Replication

Description

Gracefully remove the replication configuration of a VM. If the remote site is not available, use DELETE /replications/{replication_id} to delete the replication from the local site.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/replications/{replication_id}/actions/unconfigure
Copy

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

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

Task to monitor deletion of a replication configuration

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	}
}
_meta Optional

Response meta data. Contains data about the response payload data.

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}/replications/{replication_id}/actions/unconfigure
Vendor Extensions

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: ERROR
    server-down: ERROR


Feedback

Was this page helpful?