NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
Fetches a list of metadata for all the registered error resolvers Returns a list of metadata for all the error resolvers registered.	GET /global-manager/api/v1/error-resolver GET /api/v1/error-resolver
Resolves the error Invokes the corresponding error resolver for the given error(s) present in the payload	POST /global-manager/api/v1/error-resolver?action=resolve_error POST /api/v1/error-resolver?action=resolve_error
Fetches metadata about the given error_id Returns some metadata about the given error_id. This includes information of whether there is a resolver present for the given error_id and its associated user input data	GET /global-manager/api/v1/error-resolver/{error_id} GET /api/v1/error-resolver/{error_id}
Update node core dump configuration Update node configuration for core dump generation and rotation policy	POST /api/v1/transport-nodes/{transport-node-id}/node?action=set_coredump_config POST /api/v1/cluster/{cluster-node-id}/node?action=set_coredump_config POST /api/v1/node?action=set_coredump_config
List system core dumps	GET /api/v1/transport-nodes/{transport-node-id}/node/core-dumps GET /api/v1/cluster/{cluster-node-id}/node/core-dumps GET /api/v1/node/core-dumps
Delete core dump file	DELETE /api/v1/transport-nodes/{transport-node-id}/node/core-dumps/{file-name} DELETE /api/v1/cluster/{cluster-node-id}/node/core-dumps/{file-name} DELETE /api/v1/node/core-dumps/{file-name}
Copy system generated core dump file to a remote file store Copy system generated core dump file to a remote server. If you use scp or sftp, you must provide the remote server's SSH fingerprint. See the NSX-T Administration Guide for information and instructions about finding the SSH fingerprint.	POST /api/v1/transport-nodes/{transport-node-id}/node/core-dumps/{file-name}?action=copy_to_remote_file POST /api/v1/cluster/{cluster-node-id}/node/core-dumps/{file-name}?action=copy_to_remote_file POST /api/v1/node/core-dumps/{file-name}?action=copy_to_remote_file
Gets Node health status Returns 200 if node is healthy and 503 if node is not	GET /api/v1/reverse-proxy/node/health
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 (Deprecated)
Creates a new View.	POST /global-manager/api/v1/ui-views (Deprecated)
Delete View	DELETE /global-manager/api/v1/ui-views/{view-id} (Deprecated)
Returns View Information Returns Information about a specific View.	GET /global-manager/api/v1/ui-views/{view-id} (Deprecated)
Update View	PUT /global-manager/api/v1/ui-views/{view-id} (Deprecated)
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 (Deprecated)
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 (Deprecated)
Delete Widget Configuration Detaches 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} (Deprecated)
Returns Widget Configuration Information Returns Information about a specific Widget Configuration.	GET /global-manager/api/v1/ui-views/{view-id}/widgetconfigurations/{widgetconfiguration-id} (Deprecated)
Update Widget Configuration Updates 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} (Deprecated)