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

Remove VM From Protection Group

Description

Remove the virtual machine for a VR protection group

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/protection-management/groups/{group_id}/vms/{vm_id}/actions/remove-from-group
Copy

Path Parameters

Path Parameters

string
pairing_id Required

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


string
group_id Required

The ID of a protection group defined within current pairing


string
vm_id Required

The ID of a protected virtual machine


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

202 Accepted

Returns TaskDrResponseEntity of type application/json

A task to monitor the operation progress.

{
	"_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}/protection-management/groups/{group_id}/vms/{vm_id}/actions/remove-from-group
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?