NSX-T Data Center REST API

Associated URIs:

API Description API Path

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

Read health metrics of edge cluster


GET /api/v1/systemhealth-extended/edge-cluster (Experimental)

Read health metrics of all the edge transport nodes


Return results in paginated form.
GET /api/v1/systemhealth-extended/edge-transport-nodes (Experimental)

Read health metrics of all the host transport nodes


Return results in paginated form.
GET /api/v1/systemhealth-extended/host-transport-nodes (Experimental)

Read health metrics of unified appliance cluster


GET /api/v1/systemhealth-extended/management-cluster (Experimental)

Read health metrics of all unified appliances and the summary status of their services


GET /api/v1/systemhealth-extended/management-nodes (Experimental)

Read health metrics of an unified appliance service


GET /api/v1/systemhealth-extended/management-nodes/{node-id}/services/{service-name} (Experimental)

Read the metrics metadata for all health metrics API


GET /api/v1/systemhealth-extended/metadata (Experimental)

Read health metrics of virtual network appliance cluster


GET /api/v1/systemhealth-extended/virtual-network-appliance-cluster (Experimental)

Read health metrics of all the virtual network appliance nodes


Return results in paginated form.
GET /api/v1/systemhealth-extended/virtual-network-appliance-nodes (Experimental)