NSX-T Data Center REST API

Associated URIs:

API Description	API Path
List all segments under infra Paginated list of all segments under infra.	GET /policy/api/v1/infra/segments GET /policy/api/v1/global-infra/segments GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments
Delete infra segment Delete infra segment	DELETE /policy/api/v1/infra/segments/{segment-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
Force delete infra segment Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.	DELETE /policy/api/v1/infra/segments/{segment-id}?force=true DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
Read infra segment Read infra segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.	GET /policy/api/v1/infra/segments/{segment-id} GET /policy/api/v1/global-infra/segments/{segment-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
Create or update a segment If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes.	PATCH /policy/api/v1/infra/segments/{segment-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
Create or update a segment If segment with the segment-id is not already present, create a new segment. If it already exists, update the segment with specified attributes. Force parameter is required when workload connectivity is indirectly impacted with the current update.	PATCH /policy/api/v1/infra/segments/{segment-id}?force=true PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
Create or update a infra segment If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.	PUT /policy/api/v1/infra/segments/{segment-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}
Create or update a infra segment If segment with the segment-id is not already present, create a new segment. If it already exists, replace the segment with this object. Force parameter is required when workload connectivity is indirectly impacted with the current replacement. Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact. Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.	PUT /policy/api/v1/infra/segments/{segment-id}?force=true PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}?force=true
List all effective profiles for infra segment List all effective profiles for this segment on given enforcement point.	GET /policy/api/v1/infra/segments/{segment-id}/effective-profiles GET /policy/api/v1/global-infra/segments/{segment-id}/effective-profiles GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/effective-profiles
List SegmentConnectionBindingMap specific Segment List SegmentConnectionBindingMap specific Segment	GET /policy/api/v1/infra/segments/{segment-id}/segment-connection-binding-maps GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps
Deletes infra SegmentConnectionBindingMap. Deletes infra SegmentConnectionBindingMap.	DELETE /policy/api/v1/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Read infra SegmentConnectionBindingMap Read infra SegmentConnectionBindingMap.	GET /policy/api/v1/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Patch a infra segment connection binding map Patch the infra segment connection binding map. If binding map corresponding to the the given values is not present, the object will get created and if it is present it will be updated. This is a full replace.	PATCH /policy/api/v1/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Patch a infra segment connection binding map Patch the infra segment connection binding map. If binding map corresponding to the the given values is not present, the object will get created and if it is present it will be updated. This is a full replace.	PUT /policy/api/v1/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-connection-binding-maps/{map-id}
List Service Segments Paginated list of all Service Segments	GET /policy/api/v1/infra/segments/service-segments
Delete Service Segment Delete Service Segment with given ID	DELETE /policy/api/v1/infra/segments/service-segments/{service-segment-id}
Read Service Segment Read a Service Segment with the given id	GET /policy/api/v1/infra/segments/service-segments/{service-segment-id}
Create a service segment A service segment with the service-segment-id is created. Modification of service segment is not supported.	PATCH /policy/api/v1/infra/segments/service-segments/{service-segment-id}
Create service segment A service segment with the service-segment-id is created. Modification of service segment is not supported.	PUT /policy/api/v1/infra/segments/service-segments/{service-segment-id}
List SegmentConnectionBindingMap specific Segment List SegmentConnectionBindingMap specific Segment	GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps
Deletes infra SegmentConnectionBindingMap. Deletes infra SegmentConnectionBindingMap.	DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Read Tier1 SegmentConnectionBindingMap Read Tier1 SegmentConnectionBindingMap.	GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Patch a tier1 segment connection binding map Patch the infra segment connection binding map. If binding map corresponding to the the given values is not present, the object will get created and if it is present it will be updated. This is a full replace.	PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id}
Patch a tier1 segment connection binding map Patch the infra segment connection binding map. If binding map corresponding to the the given values is not present, the object will get created and if it is present it will be updated. This is a full replace.	PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-connection-binding-maps/{map-id}