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
|
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
|
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
|
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
|
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
|
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
|
Returns the Views based on query criteria defined in ViewQueryParameters.If no query params are specified then all the views entitled for the user are returned. The views to which a user is entitled to include the views created by the user and the shared views. |
GET /global-manager/api/v1/ui-views
|
Creates a new View. |
POST /global-manager/api/v1/ui-views
|
Delete View |
DELETE /global-manager/api/v1/ui-views/<view-id>
|
Returns View InformationReturns Information about a specific View. |
GET /global-manager/api/v1/ui-views/<view-id>
|
Update View |
PUT /global-manager/api/v1/ui-views/<view-id>
|
Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.If no query params are specified then all the Widget Configurations of the specified view are returned. |
GET /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations
|
Creates a new Widget Configuration.Creates a new Widget Configuration and adds it to the specified view. Supported resource_types are LabelValueConfiguration, DonutConfiguration, GridConfiguration, StatsConfiguration, MultiWidgetConfiguration, GraphConfiguration and ContainerConfiguration. Note: Expressions should be given in a single line. If an expression spans multiple lines, then form the expression in a single line. For label-value pairs, expressions are evaluated as follows: a. First, render configurations are evaluated in their order of appearance in the widget config. The 'field' is evaluated at the end. b. Second, when render configuration is provided then the order of evaluation is 1. If expressions provided in 'condition' and 'display value' are well-formed and free of runtime-errors such as 'null pointers' and evaluates to 'true'; Then remaining render configurations are not evaluated, and the current render configuration's 'display value' is taken as the final value. 2. If expression provided in 'condition' of render configuration is false, then next render configuration is evaluated. 3. Finally, 'field' is evaluated only when every render configuration evaluates to false and no error occurs during steps 1 and 2 above. If an error occurs during evaluation of render configuration, then an error message is shown. The display value corresponding to that label is not shown and evaluation of the remaining render configurations continues to collect and show all the error messages (marked with the 'Label' for identification) as 'Error_Messages: {}'. If during evaluation of expressions for any label-value pair an error occurs, then it is marked with error. The errors are shown in the report, along with the label value pairs that are error-free. Important: For elements that take expressions, strings should be provided by escaping them with a back-slash. These elements are - condition, field, tooltip text and render_configuration's display_value. |
POST /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations
|
Delete Widget ConfigurationDetaches widget from a given view. If the widget is no longer part of any view, then it will be purged. |
DELETE /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
|
Returns Widget Configuration InformationReturns Information about a specific Widget Configuration. |
GET /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
|
Update Widget ConfigurationUpdates the widget at the given view. If the widget is referenced by other views, then the widget will be updated in all the views that it is part of. |
PUT /global-manager/api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
|
Get the version whitelistGet whitelist of versions for different components |
GET /api/v1/upgrade/version-whitelist
|
Get the version whitelist for the specified componentGet whitelist of versions for a component. Component can include HOST, EDGE, CCP, MP |
GET /api/v1/upgrade/version-whitelist/<component_type>
|
Update the version whitelist for the specified component typeUpdate the version whitelist for the specified component type (HOST, EDGE, CCP, MP). |
PUT /api/v1/upgrade/version-whitelist/<component_type>
|