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

Delete Pairing

Description

Delete existing pairing with remote Site Recovery Manager server.

Request

Request

URL

URL


delete
https://{api_host}//pairings/{pairing_id}
Copy

Path Parameters

Path Parameters

string
pairing_id Required

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


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns Task of type application/json

Delete pairing task.

{
	"complete_time": 0,
	"description": "string",
	"description_id": "string",
	"entity": "string",
	"entity_name": "string",
	"error": {
		"details": "string",
		"message": "string"
	},
	"id": "string",
	"progress": 0,
	"queued_time": 0,
	"result": {},
	"start_time": 0,
	"status": "QUEUED"
}
string
id Required

ID of the task.


string
status Required

Status of the task.

Possible values are: QUEUEDRUNNINGSUCCESSERRORCANCELLED


string
description Optional

Description of the task.


string
description_id Optional

ID of the description of the task.


string
entity Optional

Entity the task is executed upon.


string
entity_name Optional

Name of the entity the task is executed upon.


integer as int64
complete_time Changed Optional

The complete time of the task, in milliseconds.


integer as int32
progress Optional

The current progress of the task, in percentage number.


integer as int64
queued_time Changed Optional

The queued time of the task, in milliseconds.


object
result Optional

Information about the task result if the task status is SUCCESS.


integer as int64
start_time Changed Optional

The start time of the task, in milliseconds.


error Optional

Detailed information about the error if the task status is ERROR.

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

PowerCLI Client SDK Example

Invoke-SrmDeletePairing -pairingId "MypairingId"

cURL Command

curl -X DELETE https://{api_host}/pairings/{pairing_id}
Vendor Extensions

Vendor Extensions

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


[{"label":"Latest (2.0.0)","version":"latest"},{"version":"1.0.0"}]
srm-rest-api
What's changed in latest?
INTRODUCED
Feedback

Was this page helpful?