| API Description | API Path |
|---|---|
Returns warning threshold(s) set for NSX Objects.Returns warning threshold(s) set for NSX Objects. |
GET /api/v1/capacity/threshold
|
Updates the warning threshold(s) for NSX Objects.Updates the warning threshold(s) for NSX Objects specified, and returns new threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT threshold_type which represents global thresholds. |
PUT /api/v1/capacity/threshold
|
Returns capacity usage data for NSX objects |
GET /api/v1/capacity/usage
|
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 /api/v1/ui-views
|
Creates a new View. |
POST /api/v1/ui-views
|
Delete View |
DELETE /api/v1/ui-views/<view-id>
|
Returns View InformationReturns Information about a specific View. |
GET /api/v1/ui-views/<view-id>
|
Update View |
PUT /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 /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 /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 /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
|
Returns Widget Configuration InformationReturns Information about a specific Widget Configuration. |
GET /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 /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
|