| API Description | API Path |
|---|---|
Request one-time inventory summary.Request one-time inventory summary. The backup will be uploaded using the same server configuration as for an automatic backup. |
POST /api/v1/cluster?action=summarize_inventory_to_remote
|
Request one-time backupRequest one-time backup. The backup will be uploaded using the same server configuration as for automatic backup. |
POST /api/v1/cluster?action=backup_to_remote
|
Get ssh fingerprint of remote(backup) serverGet SHA256 fingerprint of ECDSA key of remote server. The caller should independently verify that the key is trusted. |
POST /api/v1/cluster/backups?action=retrieve_ssh_fingerprint
|
Get backup configurationGet a configuration of a file server and timers for automated backup. Fields that contain secrets (password, passphrase) are not returned. |
GET /api/v1/cluster/backups/config
|
Configure backupConfigure file server and timers for automated backup. If secret fields are omitted (password, passphrase) then use the previously set value. |
PUT /api/v1/cluster/backups/config
|
Get backup historyGet history of previous backup operations |
GET /api/v1/cluster/backups/history
|
Get all backup related information for a siteGet a configuration of a file server, timers for automated backup, latest backup status, backups list for a site. Fields that contain secrets (password, passphrase) are not returned. |
GET /api/v1/cluster/backups/overview
|
Get backup statusGet status of active backup operations |
GET /api/v1/cluster/backups/status
|
Initiate a restore operationStart 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 /api/v1/cluster/restore?action=start
|
Advance any suspended restore operationAdvance 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 /api/v1/cluster/restore?action=advance
|
Cancel any running restore operationThis 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 /api/v1/cluster/restore?action=cancel
|
Suspend any running restore operationSuspend 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 /api/v1/cluster/restore?action=suspend
|
Retry any failed restore operationRetry 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 /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 /api/v1/cluster/restore/backuptimestamps
|
Deprecated. Get Restore configurationDeprecated. 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 /api/v1/cluster/restore/config
(Deprecated)
|
Deprecated. Configure Restore SFTP server credentialsDeprecated. 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 /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 /api/v1/cluster/restore/instruction-resources
|
Query Restore Request StatusReturns status information for the specified NSX cluster restore request. |
GET /api/v1/cluster/restore/status
|