Get Recovery Plans

Get Recovery Plans

This request returns all recovery plans.

Request
URI
GET
https://{api_host}/recovery-plans
COPY
Query Parameters
string
displayName
Optional

Display name of recovery plan.

displayName example 
Recovery Plan 1
string
description
Optional

Description of recovery plan.

description example 
Plain Text
string
owner
Optional

Owner of the recovery plan.

owner example 
admin1
string
sort
Optional

Fields to sort by.

sort example 
owner
integer
limit
Optional

Limit of query.

limit example 
100
integer
offset
Optional

Offset of query.

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns QueryResult_of_RecoveryPlanInfo of type(s) application/json;charset=UTF-8 
{
    "items": [
        {
            "description": "Example of a plan",
            "displayName": "Plan 1",
            "executionInfo": {
                "isSuspendRequested": false,
                "lastError": {
                    "args": [],
                    "code": "Forbidden",
                    "msg": "Permission denied.",
                    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
                },
                "lastOperation": "string",
                "promptStepId": "5ee9224f-305d-46f6-865f-b605e70acef8",
                "state": "string"
            },
            "id": "2bfb7696-3aa1-49d3-bb40-d9e97df1baba",
            "isMigration": false,
            "owner": "org1@site1",
            "scheduledSyncTime": 1901071800000
        }
    ],
    "limit": 100,
    "offset": 0,
    "total": 3
}
array of RecoveryPlanInfo
items
Optional

A list of items.

integer As int32 As int32
limit
Optional

Maximum number of items that this query could retrieve.

integer As int32 As int32
offset
Optional

How much items were skipped, before retrieving the actual items.

integer As int64 As int64
total
Optional

The total number of items.


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Recovery Plans Operations
POST
Add Recovery Plan Step
DELETE
Cleanup Failover Test Recovery Plan
POST
Clone Recovery Plan
POST
Create Recovery Plans
DELETE
Delete Recovery Plan
DELETE
Delete Recovery Plan Step
POST
Failover Recovery Plan
GET
Get Recovery Plan
GET
Get Recovery Plan Report
GET
Get Recovery Plan Step
GET
Get Recovery Plan Steps
GET
Get Recovery Plans
POST
Migrate Recovery Plan
POST
Recovery Plan Execution Cookie
GET
Recovery Plan Executions
POST
Reorder Recovery Plan Step
POST
Schedule Recovery Plan Sync
POST
Suspend Recovery Plan
POST
Test Recovery Plan
PATCH
Update Recovery Plan
PATCH
Update Recovery Plan Step