Policy > Networking > Connectivity > Segments > Segments (Fixed)

Associated URIs:

API Description	API Path
Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance. Paginated list of all fixed segments (identified as /policy/api/v1/infra/tier-1s//segments/) under Tier-1 instance. This API call does not return flexible segments (identified as /policy/api/v1/infra/segments/) connected to the Tier-1. To return all segments connected as a downlink to a Tier-1 one possibility is to use the search API with: https://{{nsx-mgr}}/policy/api/v1/search?query=resource_type:Segment%20AND%20connectivity_path:“/infra/tier-1s/ Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PUT/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/tier-1s/{tier-1-id}/segments GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments
Delete segment Delete segment	DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id} DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
Force delete segment Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.	DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}?force=true DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}?force=true
Read segment Read segment Note: Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the "l2_extension" object in the PUT/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/tier-1s/{tier-1-id}/segments/{segment-id} GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id} GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/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. 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.	PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id} PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/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, 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 PUT API payload, the path returned in the PUT/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/tier-1s/{tier-1-id}/segments/{segment-id} PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}
List all effective profiles for segment List all effective profiles for this segment on given enforcement point.	GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/effective-profiles
Delete static ARP config Delete static ARP config	DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
Read static ARP config Read static ARP config	GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
Create or update a static ARP config Create static ARP config with Tier-1 and segment IDs provided if it doesn't exist, update with provided config if it's already created.	PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp
Create or update a static ARP config Create static ARP config with Tier-1 and segment IDs provided if it doesn't exist, update with provided config if it's already created.	PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/static-arp