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

Move Recovery Plan Folder

Description

Move a specified folder into a destination folder. This operation is typically used by clients when implementing a drag-and-drop interface for moving folders.

The objects that can be moved into a folder depend on the parent folder’s type. You can move only recovery plans and recovery plan folders into a folder constructed for recovery plans. You can move only protection groups and protection group folders into a folder constructed for protection groups.

This method requires VcDr.RecoveryProfile.com.vmware.vcDr.Edit privilege on the moved folder and the source and destination parent folders.

Request

Request

URL

URL


post
https://{api_host}//pairings/{pairing_id}/recovery-management/inventory/{folder_id}/actions/move
Copy

Path Parameters

Path Parameters

string
pairing_id Required

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


string
folder_id Required

ID of the recovery plan folder.


Request Body

Request Body

MoveObjectSpec of mimetype application/json Required

Spec describing the destination folder for the movement of the recovery plan folder.

{
	"destination_parent": "string"
}
string
destination_parent Required

Destination parent folder for the movement operation.

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 track progress of the operation.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"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"
}
_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

PowerCLI Client SDK Example

$MoveObjectSpec = Initialize-SrmMoveObjectSpec -DestinationParent "MyDestinationParent"
Invoke-SrmMoveRecoveryPlanFolder -pairingId "MypairingId" -folderId "MyfolderId" -moveObjectSpec $moveObjectSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"destination_parent":"string"}' https://{api_host}/pairings/{pairing_id}/recovery-management/inventory/{folder_id}/actions/move
Vendor Extensions

Vendor Extensions

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


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

Was this page helpful?