NSX-T Data Center REST API

Get automatic health checks

Get health check performed by system automatically for all transport zones or
a specific transport zone.
This API is only available when using VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/auto-health-checks
Request Headers:
n/a
Query Parameters:
HealthCheckTransportZoneRequest+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/auto-health-checks?transport_zone_path=/infra/sites/default/enforcement-points/default/transport-zones/1b3a2f36-bfd1-443e-a0f6-4de01abc963e

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
PolicyAutomaticHealthCheckListResult+

Example Response:

{ "transport_zone_path": "/infra/sites/default/enforcement-points/default/transport-zones/1b3a2f36-bfd1-443e-a0f6-4de01abc963e", "result": { "vlan_mtu_status": "UNKNOWN", "results_per_transport_node": [ { "transport_node_path": "/infra/sites/default/enforcement-points/default/host-transport-nodes/localhost-ca1ab257-d106-460c-9b19-3b6da34d9bf8host-56", "result_on_host_switch": { "host_switch_name": "dvs1", "results_per_uplink": [ { "uplink_name": "Uplink 1", "vlan_and_mtu_allowed": [ { "start": 0, "end": 0 } ], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 2", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 3", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 4", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] } ], "vlan_mtu_status": "UNKNOWN", "updated_time": 1726141213189 } }, { "transport_node_path": "/infra/sites/default/enforcement-points/default/host-transport-nodes/localhost-ca1ab257-d106-460c-9b19-3b6da34d9bf8host-16", "result_on_host_switch": { "host_switch_name": "dvs1", "results_per_uplink": [ { "uplink_name": "Uplink 1", "vlan_and_mtu_allowed": [ { "start": 0, "end": 0 } ], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 2", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 3", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] }, { "uplink_name": "Uplink 4", "vlan_and_mtu_allowed": [], "mtu_disallowed": [], "vlan_disallowed": [] } ], "vlan_mtu_status": "UNKNOWN", "updated_time": 1726141213170 } } ], "updated_time": 1726141918919 } }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: