NSX-T Data Center REST API

Get tier-1 segments by configuration state

Returns all tier-1 segments with configuration state on the enforcement
point specified in the request

Request:

Method:
GET
URI Path(s):
/policy/api/v1/global-infra/tier-1s/<tier-1-id>/segments/state
/policy/api/v1/infra/tier-1s/<tier-1-id>/segments/state
Request Headers:
n/a
Query Parameters:
SegmentStateRequestParameters+
Request Body:
n/a

Example Request:

https://{{nsx-mgr}}/policy/api/v1/infra/tier-1s/TLR1_LR/segments/state?configuration_state=success&enforcement_point_path=/infra/sites/default/enforcement-points/default

Successful Response:

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

Example Response:

{ "results": [ { "segment_path": "/infra/tier-1s/TLR1_LR/segments/TIER1_DOWNLINK_SWITCH", "state": "success", "details": [] } ], "result_count": 1 }

Required Permissions:

read

Feature:

policy_statistics

Additional Errors: