Update Recovery Plan Step

Update Recovery Plan Step

This request updates a step of the specified recovery plan.

Request
URI
PATCH
https://{api_host}//recovery-plans/{recoveryPlanId}/steps/{recoveryStepId}
COPY
Path Parameters
string
recoveryPlanId
Required

recoveryPlanId

recoveryPlanId example 
e7bf7128-2825-48ca-9075-3f496de70ffe
string
recoveryStepId
Required

recoveryStepId

recoveryStepId example 
112f9661-ebec-45ad-875b-18e2e3f9e39b
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body
RecoveryStepSettings of type(s) application/json
Required 
{
    "delay": 30000,
    "name": "Step 1",
    "prompt": "Prompt message",
    "replications": []
}
integer As int64 As int64
delay
Optional

Delay to wait after failover/migrate/test before executing next step (ms).

string
name
Optional

Recovery step display name (unique across the recovery plan).

string
prompt
Optional

Message to wait for the user to confirm before proceeding with the next task.

array of ReplicatedResource
replications
Optional

List of replicated resources (replications) associated with the step.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RecoveryStepInfo of type(s) application/json;charset=UTF-8 
{
    "delay": 30000,
    "id": "57aefff3-9fd0-4185-ae75-2cce62de43df",
    "isRecovered": false,
    "name": "Step 1",
    "prompt": "Prompt message",
    "recoveryPlanId": "536ece79-1f49-4d6d-b558-41fde41c7c72",
    "replications": [],
    "sequence": 0,
    "state": "string"
}
integer As int64 As int64
delay
Optional

Delay to wait after failover/migrate/test before executing next step (ms).

string As uuid As uuid
id
Optional

The unique identifier of the step.

boolean
isRecovered
Optional

Whether the recovery step had completed a failover/migrate.

string
name
Optional

Recovery step display name (unique across the recovery plan).

string
prompt
Optional

The message to wait for the user to confirm before proceeding with the next task.

string As uuid As uuid
recoveryPlanId
Optional

The unique identifier of the plan.

array of ReplicatedResource
replications
Optional

List of replicated resources (replications) associated to the step.

integer As int32 As int32
sequence
Optional

Step index - determines the order of the steps.

RecoveryPlanState
state
Optional

state


401

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

Returns ApiError of type(s) application/vnd.vmware.h4-v4.6+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.6+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