Create Recovery Plans

Create Recovery Plans

This request creates a new recovery plan.

Request
URI
POST
https://{api_host}/recovery-plans
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body
NewRecoveryPlanSettings of type(s) application/json
Required 
{
    "description": "Example of a plan",
    "displayName": "Plan 1",
    "isMigration": false,
    "scheduledSyncTime": 1901071800000
}
string
description
Optional

Recovery plan description.

string
displayName
Optional

Recovery plan display name (unique across recovery plans).

boolean
isMigration
Optional

Whether the plan is a migration plan

integer As int64 As int64
scheduledSyncTime
Optional

Time at which the replications of the recovery plan will get synced.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RecoveryPlanInfo of type(s) application/json;charset=UTF-8 
{
    "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
}
string
description
Optional

Recovery plan description.

string
displayName
Optional

Recovery plan display name (unique across recovery plans).

RecoveryPlanInfo_ExecutionInfo
executionInfo
Optional

executionInfo

string As uuid As uuid
id
Optional

Recovery plan id.

boolean
isMigration
Optional

Whether the plan is a migration plan.

string
owner
Optional

Recovery plan owner.

integer As int64 As int64
scheduledSyncTime
Optional

Time at which the replications of the recovery plan will get synced. 0 means not scheduled.


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
POST
Chown Recovery Plan
DELETE
Cleanup Failover Test Recovery Plan
POST
Clone Recovery Plan
GET
Cloud Recovery Plans
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
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