NSX-T Data Center REST API

Associated URIs:

API Description	API Path
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.	POST /policy/api/v1/cluster/restore?action=start POST /api/v1/cluster/restore?action=start
Advance any suspended restore operation Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.	POST /policy/api/v1/cluster/restore?action=advance POST /api/v1/cluster/restore?action=advance
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.	POST /policy/api/v1/cluster/restore?action=suspend POST /api/v1/cluster/restore?action=suspend
Cancel any running restore operation This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically "/api/v1/cluster/restore/status" API. The response object (ClusterRestoreStatus), contains a field "endpoints". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.	POST /policy/api/v1/cluster/restore?action=cancel POST /api/v1/cluster/restore?action=cancel
Retry any failed restore operation Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.	POST /policy/api/v1/cluster/restore?action=retry POST /api/v1/cluster/restore?action=retry
List timestamps of all available Cluster Backups. Returns timestamps for all backup files that are available on the SFTP server.	GET /policy/api/v1/cluster/restore/backuptimestamps GET /api/v1/cluster/restore/backuptimestamps
Deprecated. Get Restore configuration Deprecated. Please use API /cluster/backups/config, to get remote file server(where backuped-up files are stored) details durign restore. In older versions - Get configuration information for the file server used to store backed-up files. Fields that contain secrets (password, passphrase) are not returned.	GET /policy/api/v1/cluster/restore/config (Deprecated) GET /api/v1/cluster/restore/config (Deprecated)
Deprecated. Configure Restore SFTP server credentials Deprecated. Please use API /cluster/backups/config, to configure remote file server(where backed-up files are stored) details during restore. In older versions - Configure file server where the backed-up files used for the Restore operation are available.	PUT /policy/api/v1/cluster/restore/config (Deprecated) PUT /api/v1/cluster/restore/config (Deprecated)
List resources for a given instruction, to be shown to/executed by users. For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.	GET /policy/api/v1/cluster/restore/instruction-resources GET /api/v1/cluster/restore/instruction-resources
Query Restore Request Status Returns status information for the specified NSX cluster restore request.	GET /api/v1/cluster/restore/status