NSX-T Data Center REST API

Associated URIs:

API Description API Path

Read Antrea cluster heartbeat config list


Paginated list of all Antrea cluster heartbeat config
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes-heartbeat-config

Read Antrea cluster status list


Paginated list of all Antrea cluster status
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes-status

Read Antrea heartbeat configuration


GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config

Patch the Antrea heartbeat configuration


PATCH /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config

Update the Antrea heartbeat configuration


PUT /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/heartbeat-config

Read Antrea cluster status


Read Antrea cluster status for a given Antrea cluster identifier.
GET /policy/api/v1/infra/sites/<site-id>/enforcement-points/<enforcementpoint-id>/cluster-control-planes/<cluster-control-plane-id>/status

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 (Deprecated)

Create a system health plugin


Create a system health plugin.
POST /api/v1/systemhealth/plugins (Deprecated)

Delete an existing system health plugin


Delete an existing system health plugin by ID.
DELETE /api/v1/systemhealth/plugins/<plugin-id> (Deprecated)

Show the details of a system health plugin


Show the details of a system health plugin.
GET /api/v1/systemhealth/plugins/<plugin-id> (Deprecated)

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 (Deprecated)

Create a system health profile


Create a system health profile.
POST /api/v1/systemhealth/profiles (Deprecated)

Delete an existing system health profile


Delete an existing system health profile by ID.
DELETE /api/v1/systemhealth/profiles/<profile-id> (Deprecated)

Show the details of a system health profile


Show the details of a system health profile.
GET /api/v1/systemhealth/profiles/<profile-id> (Deprecated)

Update a system health profile


Update a system health profile definition.
PUT /api/v1/systemhealth/profiles/<profile-id> (Deprecated)

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