| API Description | API Path |
|---|---|
List all segments under infraPaginated 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 segmentDelete 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 segmentForce 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 segmentRead 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 segmentIf 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 segmentIf 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 infra segmentIf 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 segmentIf 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 segmentList 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 |