Associated URIs:

API Description	API Path
Collect audit logs from registered manager nodes This API is executed on a manager node to display audit logs from all nodes inside the management plane cluster. An audit log collection will be triggered if the local master audit log is outdated.	POST /api/v1/administration/audit-logs
Get the list of all Alarms currently known to the system. Returns a list of all Alarms currently known to the system.	GET /api/v1/alarms
Bulk update the status of zero or more Alarms. Bulk update the status of zero or more Alarms that match the specified filters. The new_status value can be OPEN, ACKNOWLEDGED, SUPPRESSED, or RESOLVED. If new_status is SUPPRESSED, the suppress_duration query parameter must also be specified.	POST /api/v1/alarms?action=set_status
Get Alarm identified by alarm-id. Returns alarm associated with alarm-id. If HTTP status 404 is returned, this means the specified alarm-id is invalid or the alarm with alarm-id has been deleted. An alarm is deleted by the system if it is RESOLVED and older than eight days. The system can also delete the remaining RESOLVED alarms sooner to free system resources when too many alarms are being generated. When this happens the oldest day's RESOLVED alarms are deleted first.	GET /api/v1/alarms/<alarm-id>
Update staus of alarm identified by alarm-id. Update status of an Alarm. The new_status value can be OPEN, ACKNOWLEDGED, SUPPRESSED, or RESOLVED. If new_status is SUPPRESSED, the suppress_duration query parameter must also be specified.	POST /api/v1/alarms/<alarm-id>?action=set_status
Get automatic health check toggle Get detailed info for automatic health check toggle.	GET /api/v1/automatic-health-check-toggle
Update automatic health check toggle Change status of automatic health check toggle to enabled/disabled.	PUT /api/v1/automatic-health-check-toggle
List automatic health checks Query automatic health checks with list parameters.	GET /api/v1/automatic-health-checks
Get an automatic health check Get health check performed by system automatically for specific transport zone.	GET /api/v1/automatic-health-checks/transport-zones/<transport-zone-id>
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
Fetches a list of metadata for all the registered error resolvers Returns a list of metadata for all the error resolvers registered.	GET /api/v1/error-resolver
Resolves the error Invokes the corresponding error resolver for the given error(s) present in the payload	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 /api/v1/error-resolver/<error_id>
Get the list of all Events defined in NSX. Returns a list of all Events defined in NSX.	GET /api/v1/events
Get Events identified by event-id. Returns event associated with event-id.	GET /api/v1/events/<event-id>
Reset all user configurable values to factory defaults. Reset all user configurable values for event identified by event-id to factory defaults.	POST /api/v1/events/<event-id>?action=set_default
Update event associated with event-id. Update event identified by event-id.	PUT /api/v1/events/<event-id>
Collect alarms from all NSX nodes This API is executed on a manager node to return current alarms from all NSX nodes. This API is deprecated as part of alarm framework enhancements. Please use below new APIs: GET /alarms GET /alarms/<alarm-id> POST /alarms/<alarm-id>?action=set_status POST /alarms?action=set_status GET /events GET /events/<event-id> PUT /events/<event-id> POST /events/<event-id>?action=set_default	GET /api/v1/hpm/alarms (Experimental) (Deprecated)
List all health performance monitoring feature stacks	GET /api/v1/hpm/features
Read health performance monitoring configuration for feature stack Returns the complete set of client type data collection configuration records for the specified feature stack.	GET /api/v1/hpm/features/<feature-stack-name>
Reset the data collection frequency configuration setting to the default values	POST /api/v1/hpm/features/<feature-stack-name>?action=reset_collection_frequency
Update health performance monitoring configuration for feature stack Apply the data collection configuration for the specified feature stack.	PUT /api/v1/hpm/features/<feature-stack-name>
Read global health performance monitoring configuration	GET /api/v1/hpm/global-config
Set the global configuration for aggregation service related data collection	PUT /api/v1/hpm/global-config
List latency profiles	GET /api/v1/latency-profiles
Create a new latency profile	POST /api/v1/latency-profiles
Delete an existing latency profile	DELETE /api/v1/latency-profiles/<latency-profile-id>
Get an existing latency profile configuration	GET /api/v1/latency-profiles/<latency-profile-id>
Update an existing latency profile	PUT /api/v1/latency-profiles/<latency-profile-id>
List system core dumps	GET /api/v1/node/core-dumps GET /api/v1/transport-nodes/<transport-node-id>/node/core-dumps GET /api/v1/cluster/<cluster-node-id>/node/core-dumps
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/node/core-dumps/<file-name>?action=copy_to_remote_file 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
Returns a list of registered notification watchers. Returns a list of registered notification watchers.	GET /api/v1/notification-watchers
Add a new notification watcher. Add a new notification watcher.	POST /api/v1/notification-watchers
Delete an existing Notification-Watcher. Delete notification watcher.	DELETE /api/v1/notification-watchers/<watcher-id>
Returns notification watcher by watcher id. Returns notification watcher by watcher id.	GET /api/v1/notification-watchers/<watcher-id>
Update notification watcher. Update notification watcher.	PUT /api/v1/notification-watchers/<watcher-id>
Get notifications for the specified watcher ID. Get notifications for the specified watcher ID.	GET /api/v1/notification-watchers/<watcher-id>/notifications
Add uri filters for the specified watcher ID. Add uri filters for the specified watcher ID.	POST /api/v1/notification-watchers/<watcher-id>/notifications?action=add_uri_filters
Delete uri filters for the specified watcher ID. Delete uri filters for the specified watcher ID.	POST /api/v1/notification-watchers/<watcher-id>/notifications?action=delete_uri_filters
Update notifications for the specified watcher ID. Update notifications for the specified watcher ID.	PUT /api/v1/notification-watchers/<watcher-id>/notifications
Show the details of process status in given appliance Show the details of process status in given appliance.	GET /api/v1/systemhealth/appliances/<appliance-id>/latency/status
Show the details of process status in given appliance Show the details of process status in given appliance. The appliance id can be obtained by below APIs. 1. /api/v1/cluster/nodes 2. /api/v1/systemhealth/appliances/process/status	GET /api/v1/systemhealth/appliances/<appliance-id>/process/status
Show the details of latency status for all appliances Show the details of latency status in all appliances.	GET /api/v1/systemhealth/appliances/latency/status
Show the details of process status in all appliances. Show the details of process status in all appliances.	GET /api/v1/systemhealth/appliances/process/status
Create container cluster status list	DELETE /api/v1/systemhealth/container-cluster/<cluster-id>/ncp/status
Get the container cluster status by given id	GET /api/v1/systemhealth/container-cluster/<cluster-id>/ncp/status
Get all the container cluster status	GET /api/v1/systemhealth/container-cluster/ncp/status
Create container cluster status list	POST /api/v1/systemhealth/container-cluster/ncp/status
Show all the system health plugin Show all the system health plugins.	GET /api/v1/systemhealth/plugins
Create a system health plugin Create a system health plugin.	POST /api/v1/systemhealth/plugins
Delete an existing system health plugin Delete an existing system health plugin by ID.	DELETE /api/v1/systemhealth/plugins/<plugin-id>
Show the details of a system health plugin Show the details of a system health plugin.	GET /api/v1/systemhealth/plugins/<plugin-id>
Upload a plugin File to MP	POST /api/v1/systemhealth/plugins/<plugin-id>/files/<file-name>/data
Show the installed system health plugin list Show all the installed system health plugins on given node	GET /api/v1/systemhealth/plugins/status/<node-id>
List all system health profiles List all system health profiles.	GET /api/v1/systemhealth/profiles
Create a system health profile Create a system health profile.	POST /api/v1/systemhealth/profiles
Delete an existing system health profile Delete an existing system health profile by ID.	DELETE /api/v1/systemhealth/profiles/<profile-id>
Show the details of a system health profile Show the details of a system health profile.	GET /api/v1/systemhealth/profiles/<profile-id>
Update a system health profile Update a system health profile definition.	PUT /api/v1/systemhealth/profiles/<profile-id>
Get the containter status on given node	GET /api/v1/systemhealth/transport-nodes/<node-id>/container/agent/status
Get the containter hyperbus status on given node	GET /api/v1/systemhealth/transport-nodes/<node-id>/container/hyperbus/status
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 Information Returns 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 Configuration Detaches 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 Information Returns Information about a specific Widget Configuration.	GET /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>
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 /api/v1/ui-views/<view-id>/widgetconfigurations/<widgetconfiguration-id>

System Administration > Monitoring

Associated URIs:

Collect audit logs from registered manager nodes

Get the list of all Alarms currently known to the system.

Bulk update the status of zero or more Alarms.

Get Alarm identified by alarm-id.

Update staus of alarm identified by alarm-id.

Get automatic health check toggle

Update automatic health check toggle

List automatic health checks

Get an automatic health check

Returns warning threshold(s) set for NSX Objects.

Updates the warning threshold(s) for NSX Objects.

Returns capacity usage data for NSX objects

Fetches a list of metadata for all the registered error resolvers

Resolves the error

Fetches metadata about the given error_id

Get the list of all Events defined in NSX.

Get Events identified by event-id.

Reset all user configurable values to factory defaults.

Update event associated with event-id.

Collect alarms from all NSX nodes

List all health performance monitoring feature stacks

Read health performance monitoring configuration for feature stack

Reset the data collection frequency configuration setting to the default values

Update health performance monitoring configuration for feature stack

Read global health performance monitoring configuration

Set the global configuration for aggregation service related data collection

List latency profiles

Create a new latency profile

Delete an existing latency profile

Get an existing latency profile configuration

Update an existing latency profile

List system core dumps

Copy system generated core dump file to a remote file store

Returns a list of registered notification watchers.

Add a new notification watcher.

Delete an existing Notification-Watcher.

Returns notification watcher by watcher id.

Update notification watcher.

Get notifications for the specified watcher ID.

Add uri filters for the specified watcher ID.

Delete uri filters for the specified watcher ID.

Update notifications for the specified watcher ID.

Show the details of process status in given appliance

Show the details of process status in given appliance

Show the details of latency status for all appliances

Show the details of process status in all appliances.

Create container cluster status list

Get the container cluster status by given id

Get all the container cluster status

Create container cluster status list

Show all the system health plugin

Create a system health plugin

Delete an existing system health plugin

Show the details of a system health plugin

Upload a plugin File to MP

Show the installed system health plugin list

List all system health profiles

Create a system health profile

Delete an existing system health profile

Show the details of a system health profile

Update a system health profile

Get the containter status on given node

Get the containter hyperbus status on given node

Returns the Views based on query criteria defined in ViewQueryParameters.

Creates a new View.

Delete View

Returns View Information

Update View

Returns the Widget Configurations based on query criteria defined in WidgetQueryParameters.

Creates a new Widget Configuration.

Delete Widget Configuration

Returns Widget Configuration Information

Update Widget Configuration