Initiate a restore operation

Start the restore of an NSX cluster, from some previously
backed-up configuration. This operation is only valid
when a GET cluster/restore/status returns a status with value NOT_STARTED.
Otherwise, a 409 response is returned.

Request:

Method:

POST

URI Path(s):

/api/v1/cluster/restore?action=start

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

InitiateClusterRestoreRequest+

Name	Description	Type	Notes
ip_address	IP address or FQDN of the node from which the backup was taken	string	Readonly
node_id	Unique id of the backed-up configuration from which the appliance will be restored	string	Required Readonly
timestamp	Timestamp of the backed-up configuration from which the appliance will be restored	EpochMsTimestamp	Required Readonly

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/restore?action=start { "node_id": "2128af2d-d763-4a27-80e0-4933af7e4824", "timestamp" : 1435298084391 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ClusterRestoreStatus+

Name	Description	Type	Notes
backup_timestamp	Timestamp when backup was initiated in epoch millisecond	EpochMsTimestamp	Required Readonly
endpoints	The list of allowed endpoints, based on the current state of the restore process	array of ResourceLink	Required Readonly
id	Unique id for backup request	string	Required Readonly
instructions	Instructions for users to reconcile Restore operations	array of InstructionInfo	Readonly
restore_end_time	Timestamp when restore was completed in epoch millisecond	EpochMsTimestamp	Readonly
restore_start_time	Timestamp when restore was started in epoch millisecond	EpochMsTimestamp	Readonly
status		GlobalRestoreStatus
step		RestoreStep
total_steps	Total number of steps in the entire restore process	integer	Required Readonly

Example Response:

{ "id": "86e81e05-bc3c-4216-a0a2-3bf46ece68a3", "backup_timestamp": 1435298084391, "restore_start_time": 1483463180963, "restore_end_time": null, "step": { "step_number": 1, "value": "RESTORE_INITIATED", "description": "Starting cluster restore" "status": { "value": "RUNNING", "description": "The operation is currently running" } }, "status": { "value": "RUNNING", "description": "The operation is currently running" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=suspend', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] }

Initiate a restore operation

Request:

InitiateClusterRestoreRequest (schema)

Example Request:

Successful Response:

ClusterRestoreStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: