NSX-T Data Center REST API

Associated URIs:

API Description	API Path
Get the details of latency status in given appliance.	GET /policy/api/v1/infra/sha/appliances/{appliance-id}/latency/status
Get the details of process status in given appliance.	GET /policy/api/v1/infra/sha/appliances/{appliance-id}/process/status
Get the details of latency status for all appliances	GET /policy/api/v1/infra/sha/appliances/latency/status
Get the list of process status for all appliances.	GET /policy/api/v1/infra/sha/appliances/process/status
API will provide list of Sha Dynamic plugins. API will provide list of Sha Dynamic plugins.	GET /policy/api/v1/infra/sha/dynamic-plugins GET /policy/api/v1/global-infra/sha/dynamic-plugins
Delete Sha dynamic plugin Delete Sha dynamic plugin.	DELETE /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}
Read Sha dynamic plugin Read Sha dynamic plugin.	GET /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id} GET /policy/api/v1/global-infra/sha/dynamic-plugins/{plugin-id}
Create or Replace Sha dynamic plugin Create or Replace Sha dynamic plugin.	PATCH /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}
Create Sha dynamic plugin Create Sha dynamic plugin.	PUT /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}
Upload Sha dynamic plugin Upload Sha dynamic plugin content.	POST /policy/api/v1/infra/sha/dynamic-plugins/{plugin-id}/files/{file-name}
Read SHA existing monitor list. Read SHA existing monitor list.	GET /policy/api/v1/infra/sha/monitors
List the status of SHA monitors List the status of SHA monitors on certain transport node.	GET /policy/api/v1/infra/sha/monitors-status
Read certain SHA monitor. Read certain SHA monitor.	GET /policy/api/v1/infra/sha/monitors/{monitor-id}
List SHA monitor profile List SHA monitor profile.	GET /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles
Delete a SHA monitor profile Delete a SHA monitor profile.	DELETE /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}
Read a SHA monitor profile Read a SHA monitor profile.	GET /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}
Create or update a SHA monitor profile Create or update a SHA monitor profile.	PATCH /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}
Create or update a SHA monitor profile Create or update a SHA monitor profile.	PUT /policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}
Read the SHA monitor status Read the SHA monitor status on certain transport node.	GET /policy/api/v1/infra/sha/monitors/{monitor-id}/status
API will provide list of SHA profiles. API will provide list of SHA profiles.	GET /policy/api/v1/infra/sha/plugin-profiles GET /policy/api/v1/global-infra/sha/plugin-profiles
Delete SHA profile Delete Sha profile.	DELETE /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}
API will return Sha profile API will return Sha profile.	GET /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id} GET /policy/api/v1/global-infra/sha/plugin-profiles/{sha-profile-id}
Create or Replace SHA profile Create or Replace Sha profile.	PATCH /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}
Create or Replace Sha profile Create or Replace Sha profile.	PUT /policy/api/v1/infra/sha/plugin-profiles/{sha-profile-id}
Show the plugins status on given node. Show all the installed system health plugins on given node	GET /policy/api/v1/infra/sha/plugin-status/{node-id} GET /policy/api/v1/global-infra/sha/plugin-status/{node-id}
API will provide list of Sha pre-defined list. API will provide list of Sha pre-defined plugins.	GET /policy/api/v1/infra/sha/pre-defined-plugins GET /policy/api/v1/global-infra/sha/pre-defined-plugins
Read Sha pre-defined plugin Read SHA pre-defined plugin.	GET /policy/api/v1/infra/sha/pre-defined-plugins/{plugin-id} GET /policy/api/v1/global-infra/sha/pre-defined-plugins/{plugin-id}
Get all the container cluster status	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster-ncpstatus
Create container cluster status	POST /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster-ncpstatus
Delete container cluster status	DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster/{cluster-id}/ncpstatus
Get the container cluster status by given id	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/container-cluster/{cluster-id}/ncpstatus
Get high-level summary of all transport nodes. The service layer does not support source = realtime or cached.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes-aggstatus
Read status of all the transport nodes To improve performance, we have removed 'memory_used', 'memory_total', and 'cpu_usage' from the resource_usage field, and 'last_status_update_time' from the health_metrics field in the agent_status returned by the API. To obtain these metrics, use the GET /api/v1/systemhealth-extended/host-transport-nodes endpoint.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes-status
Get the container hyperbus status on given node	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/hyperbus-status
Get the container status on given node	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/node-agent-status
Get high-level summary of a transport node	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/pnic-bond-status
Read status of all transport nodes with tunnel connections to transport node	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/remote-transport-node-status
Read status of a transport node To improve performance, we have removed 'memory_used', 'memory_total', and 'cpu_usage' from the resource_usage field, and 'last_status_update_time' from the health_metrics field in the agent_status returned by the API. To obtain these metrics, use the GET /api/v1/systemhealth-extended/host-transport-nodes?node_id= endpoint.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/status
List of tunnels	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/tunnels
Tunnel properties	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/host-transport-nodes/{node-id}/tunnels/{tunnel-name}
Creates a status report of transport nodes of all the transport zones You must provide the request header "Accept:application/octet-stream" when calling this API.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-node-status-report
Creates a status json report of transport nodes of all the transport zones	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-node-status-report-json
Get high-level summary of all transport zone status. The service layer does not support source = realtime or cached.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones-aggstatus
Get high-level summary of a transport zone	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/status
Read status of transport nodes in a transport zone	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status
Creates a status report of transport nodes in a transport zone You must provide the request header "Accept:application/octet-stream" when calling this API.	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status-report
Creates a status json report of transport nodes in a transport zone	GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/transport-zones/{zone-id}/transport-node-status-report-json