System Administration > Lifecycle Management > Backup Restore Management > Restore

Suspend any running restore operation

Suspend any currently running restore operation. The restore operation is
made up of a number of steps. When this call is issued, any currently
running step is allowed to finish (successfully or with errors), and the
next step (and therefore the entire restore operation) is suspended until
a subsequent resume or cancel call is issued. This operation is only valid
when a GET cluster/restore/status returns a status with value RUNNING.
Otherwise, a 409 response is returned.

Request:

Method:
POST
URI Path(s):
/api/v1/cluster/restore?action=suspend
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/restore?action=suspend

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterRestoreStatus+

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": "Cluster restore initiated" } }, "status": { "value": "SUSPENDING", "description": "A suspend request is being processed" } "total_steps": 11, "endpoints": [ { action: POST, href: '/cluster/restore?action=resume', rel: "self" }, { action: POST, href: '/cluster/restore?action=cancel', rel: "self" } ], "instructions": [] }

Required Permissions:

crud

Feature:

utilities_backup

Additional Errors: