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

Create Recovery Plan Folder

Description

Create a new sub-folder with the specified name.

Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients can also escape any other characters in this name parameter.

This method requires VcDr.RecoveryProfile.com.vmware.vcDr.Create andVcDr.RecoveryProfile.com.vmware.vcDr.Edit privilege on the containing folder.

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
pairing_id Required

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


Request Body

Request Body

CreateFolderSpec of mimetype application/json Required

Spec describing the new plan folder to create.

{
	"name": "string"
}
string
name Required

The name of the folder to create. The name must be unique amongst the peer children nodes.


string
location Optional

Target location where the recovery plan folder will be placed. If not specified - the root folder will be used.

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

$CreateFolderSpec = Initialize-SrmCreateFolderSpec -Name "MyName" -Location "MyLocation"
Invoke-SrmCreateRecoveryPlanFolder -pairingId "MypairingId" -createFolderSpec $createFolderSpec

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"location":"string","name":"string"}' https://{api_host}/pairings/{pairing_id}/recovery-management/inventory
Vendor Extensions

Vendor Extensions

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


[{"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?