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

Get Recovery Plan Folder

Description

Get information about Site Recovery Manager recovery plan folder.

Request

Request

URL

URL


get
https://{api_host}//pairings/{pairing_id}/recovery-management/inventory/{folder_id}
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.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns RecoveryInventoryItemDrResponseEntity of type application/json

Information about Site Recovery Manager recovery plan folder.

{
	"_meta": {
		"errors": [
			{
				"code": "string",
				"field": "string",
				"message": "string"
			}
		]
	},
	"id": "string",
	"name": "string",
	"parent": "string",
	"path": "string",
	"type": "FOLDER"
}
_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

Invoke-SrmGetRecoveryPlanFolder -pairingId "MypairingId" -folderId "MyfolderId"

cURL Command

curl https://{api_host}/pairings/{pairing_id}/recovery-management/inventory/{folder_id}
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-dr-permissions:
    permissions:
        - System.View
        - System.Read
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?