Policy > Networking > Connectivity > Segments

Associated URIs:

API Description API Path

Get Group discovery profile binding map


API will get Group discovery profile binding map
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps
GET /policy/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps

Delete Group discovery profile binding map


API will delete Group discovery profile binding map
DELETE /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}

Get Group discovery profile binding map


API will get Group discovery profile binding map
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}

Create or update Group discovery profile binding map


API will create or update Group discovery profile binding map
PATCH /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}

Update Group discovery profile binding map


API will update Group discovery profile binding map
PUT /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/domains/{domain-id}/groups/{group-id}/discovery-profile-binding-maps/{discovery-profile-binding-map-id}

Get mirror stack status for Group Monitoring Profile Binding Map.


API will get mirror stack status by Group Monitoring Profile Binding Map
GET /policy/api/v1/infra/domains/{domain-id}/groups/{group-id}/group-monitoring-profile-binding-maps/{group-monitoring-profile-binding-map-id}/mirror-stack-status

List IP Discovery Profiles


API will list all IP Discovery Profiles active in current discovery profile id.
GET /policy/api/v1/infra/ip-discovery-profiles
GET /policy/api/v1/global-infra/ip-discovery-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles

Delete IP Discovery Profile


API will delete IP Discovery profile.
DELETE /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
DELETE /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}

Get IP Discovery Profile


API will get IP Discovery profile.
GET /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
GET /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}

Create IP Discovery Profile


API will create IP Discovery profile.
PATCH /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
PATCH /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}

Update IP Discovery Profile


API will update IP Discovery profile.
PUT /policy/api/v1/infra/ip-discovery-profiles/{ip-discovery-profile-id}
PUT /policy/api/v1/global-infra/ip-discovery-profiles/{ip-discovery-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/ip-discovery-profiles/{ip-discovery-profile-id}

List Mac Discovery Profiles


API will list all Mac Discovery Profiles active in current discovery profile id.
GET /policy/api/v1/infra/mac-discovery-profiles
GET /policy/api/v1/global-infra/mac-discovery-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles

Delete Mac Discovery Profile


API will delete Mac Discovery profile.
DELETE /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
DELETE /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}

Get Mac Discovery Profile


API will get Mac Discovery profile.
GET /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
GET /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}

Create Mac Discovery Profile


API will create Mac Discovery profile.
PATCH /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
PATCH /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}

Update Mac Discovery Profile


API will update Mac Discovery profile.
PUT /policy/api/v1/infra/mac-discovery-profiles/{mac-discovery-profile-id}
PUT /policy/api/v1/global-infra/mac-discovery-profiles/{mac-discovery-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/mac-discovery-profiles/{mac-discovery-profile-id}

List QoS Profiles


API will list all QoS profiles.
GET /policy/api/v1/infra/qos-profiles
GET /policy/api/v1/global-infra/qos-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles

Delete QoS profile


API will delete QoS profile.
DELETE /policy/api/v1/infra/qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}

Details of QoS profile


API will return details of QoS profile.
GET /policy/api/v1/infra/qos-profiles/{qos-profile-id}
GET /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}

Patch QoS profile.


Create a new QoS profile if the QoS profile with
given id does not already exist. If the QoS profile with the
given id already exists, patch with the existing QoS profile.
PATCH /policy/api/v1/infra/qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}

Create or Replace QoS profile.


Create or Replace QoS profile.
PUT /policy/api/v1/infra/qos-profiles/{qos-profile-id}
PUT /policy/api/v1/global-infra/qos-profiles/{qos-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/qos-profiles/{qos-profile-id}

List segment security profiles


API will list all segment security profiles.
GET /policy/api/v1/infra/segment-security-profiles
GET /policy/api/v1/global-infra/segment-security-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles

DELETE segment security profile


API will delete segment security profile with the given id.
DELETE /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
DELETE /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}

GET Segment security profile id


API will return details of the segment security profile with given id. If the
profile does not exist, it will return 404.
GET /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
GET /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}

PATCH segment security profile id


Create a new segment security profile if the segment security profile with given id does not
exist. Otherwise, PATCH the existing segment security profile
PATCH /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
PATCH /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}

PUT segment security profile id


Create or replace a segment security profile
PUT /policy/api/v1/infra/segment-security-profiles/{segment-security-profile-id}
PUT /policy/api/v1/global-infra/segment-security-profiles/{segment-security-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segment-security-profiles/{segment-security-profile-id}

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

List Infra Port Discovery Profile Binding Maps


API will list all Infra Port Discovery Profile Binding Maps in current port id.
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps

Delete Infra Port Discovery Profile Binding Profile


API will delete Infra Port Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Get Infra Port Discovery Profile Binding Map


API will get Infra Port Discovery Profile Binding Map
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Create Infra Port Discovery Profile Binding Map


API will create Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Update Infra Port Discovery Profile Binding Map


API will update Infra Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

List Infra Port Monitoring Profile Binding Maps


API will list all Infra Port Monitoring Profile Binding Maps in current port id.
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps

Delete Infra Port Monitoring Profile Binding Profile


API will delete Infra Port Monitoring Profile Binding Profile.
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Get Infra Port Monitoring Profile Binding Map


API will get Infra Port Monitoring Profile Binding Map.
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Create Infra Port Monitoring Profile Binding Map


API will create Infra Port Monitoring Profile Binding Map.
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Update Infra Port Monitoring Profile Binding Map


API will update Infra Port Monitoring Profile Binding Map.
PUT /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Get mirror stack status for Infra Port Monitoring Profile Binding Map


API will get Infra Port Monitoring Profile Binding Map mirror stack status.
GET /policy/api/v1/infra/segments/{infra-segment-id}/ports/{infra-port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status

List Infra Segment Discovery Profile Binding Maps


API will list all Infra Segment Discovery Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps

Delete Segment Discovery Profile Binding Profile


API will delete Segment Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Get Infra Segment Discovery Profile Binding Map


API will get Infra Segment Discovery Profile Binding Map
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Create Infra Segment Discovery Profile Binding Map


API will create Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Update Infra Segment Discovery Profile Binding Map


API will update Infra Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{infra-segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

List Infra Segment Monitoring Profile Binding Maps


API will list all Infra Segment Monitoring Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps

Delete Infra Segment Monitoring Profile Binding Profile


API will delete Infra Segment Monitoring Profile Binding Profile.
DELETE /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Get Infra Segment Monitoring Profile Binding Map


API will get Infra Segment Monitoring Profile Binding Map.
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Create Infra Segment Monitoring Profile Binding Map


API will create infra segment monitoring profile binding map.
PATCH /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Update Infra Segment Monitoring Profile Binding Map


API will update Infra Segment Monitoring Profile Binding Map.
PUT /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Get Infra Segment Monitoring Profile Binding Map


API will get Infra Segment Monitoring Profile Binding Map mirror stack status.
GET /policy/api/v1/infra/segments/{infra-segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status

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.

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 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 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

Get downlink port Address Resolution Protocol Proxies for infra segment


Returns ARP proxy table for downlink port on connected to the segment
GET /policy/api/v1/infra/segments/{segment-id}/arp-proxy
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy

Get downlink port Address Resolution Protocol Proxies for infra segment in CSV format


Returns ARP proxy table for downlink port on connected to the segment in CSV format
GET /policy/api/v1/infra/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-proxy?format=csv

Get infra segment bridge end point statistics using segment ID and profile path.


Get detailed information on infra segment bridge end point statistics using segment ID and profile path.
GET /policy/api/v1/infra/segments/{segment-id}/bep-statistics

Get Tier-1 segment bridge end point status using segment ID and profile path.


Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.
GET /policy/api/v1/infra/segments/{segment-id}/bep-status

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

Get infra segment MAC table in CSV


Returns MAC table for a segment
GET /policy/api/v1/infra/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/mac-table?format=csv

Get infra segment MAC table


Returns MAC table for a segment
GET /policy/api/v1/infra/segments/{segment-id}/mac-table
GET /policy/api/v1/global-infra/segments/{segment-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/mac-table

List infra segment ports


List all the ports for an infra.
GET /policy/api/v1/infra/segments/{segment-id}/ports
GET /policy/api/v1/global-infra/segments/{segment-id}/ports
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports

Delete an infra segment port


Delete an infra segment port by giving ID. Please note that this operation will not delete
the segment port from vCenter Server if the port was connected to a Virtual Machine.
Please connect Virtual Machine to another network for the segment port to be deleted
from vCenter Server.
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}

Get infra segment port by ID


Get detail information on an infra segment port by giving ID.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}

Patch an infra segment port


Create an infra segment port if it does not exist based on the IDs, or update existing port
information by replacing the port object fields which presents in the request body.
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}

Create or update an infra segment port


Create an infra segment port if it does not exist based on the IDs, or update existing port
information by replacing the port object already exists.
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}

List all effective profiles for infra segment port


List all effective profiles for this segment port on given enforcement point.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/effective-profiles

Get infra segment port MAC table in CSV


Returns MAC table for a segment port
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/mac-table?format=csv

Get MAC table for infra segment port


Returns MAC table for a segment port
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/mac-table

List Port QoS Profile Binding Maps


API will list all Port QoS Profile Binding Maps in current port id.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps

Delete Port QoS Profile Binding Profile


API will delete Port QoS Profile Binding Profile.
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Get Port QoS Profile Binding Map


API will get Port QoS Profile Binding Map.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Create Port QoS Profile Binding Map


API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Update Port QoS Profile Binding Map


API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

List infra segment port security profile binding maps


API will list all port security profile binding maps.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps

Delete the infra segment port security profile binding map


API will delete the port security profile binding map.
DELETE /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Get infra segment port security profile binding map


API will return details of the port security profile binding map. If the
security profile binding map does not exist, it will return 404.
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Patch infra segment port security profile binding map


Create a new port security profile binding map if the given security profile
binding map does not exist. Otherwise, patch the existing port security
profile binding map.
For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Create or replace the infra segment port security profile binding map


API will create or replace the port security profile binding map.
For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Get infra segment port state


Returns infra segment port state on enforcement point
GET /policy/api/v1/infra/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/global-infra/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/ports/{port-id}/state

List Segment QoS Profile Binding Maps


API will list all Segment QoS Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps

Delete Segment QoS Profile Binding Profile


API will delete Segment QoS Profile Binding Profile.
DELETE /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Get Segment QoS Profile Binding Map


API will get Segment QoS Profile Binding Map.
GET /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Create Segment QoS Profile Binding Map


API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Update Segment QoS Profile Binding Map


API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

List infra segment security profile binding maps


API will list all segment security profile binding maps.
GET /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps

Delete infra segment security profile binding map


API will delete segment security profile binding map.
DELETE /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Get infra segment security profile binding map


API will return details of the segment security profile binding map. If the
binding map does not exist, it will return 404.
GET /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Patch infra segment security profile binding map


Create a new segment security profile binding map if the given security
profile binding map does not exist. Otherwise, patch the existing segment
security profile binding map.
For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Create or replace infra segment security profile binding map


API will create or replace segment security profile binding map.
For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Get infra segment TEP table


Returns TEP table for a segment
GET /policy/api/v1/infra/segments/{segment-id}/tep-table
GET /policy/api/v1/global-infra/segments/{segment-id}/tep-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/tep-table

Get tier-1 segment TEP table in CSV


Returns TEP table for a segment in CSV
GET /policy/api/v1/infra/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/tep-table?format=csv

Get infra segment port statistics information


Get infra segment port statistics information.
GET /policy/api/v1/infra/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/global-infra/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/statistics

Get infra segment port status information


Get infra segment port status information.
GET /policy/api/v1/infra/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/global-infra/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/ports/{port-id}/status

Get infra segment state information


Get infra segment state information.
GET /policy/api/v1/infra/segments/{segments-id}/state
GET /policy/api/v1/global-infra/segments/{segments-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/state

Get infra segment statistics information


Get infra segment statistics information.
GET /policy/api/v1/infra/segments/{segments-id}/statistics
GET /policy/api/v1/global-infra/segments/{segments-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segments-id}/statistics

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}

Get infra segments by configuration state


Returns all infra segments with configuration state on the enforcement
point specified in the request
GET /policy/api/v1/infra/segments/state
GET /policy/api/v1/global-infra/segments/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/state

List L2 Bridge Endpoint Profiles


List all L2 bridge profiles
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles

Delete L2 Bridge Endpoint Profile


API will delete L2 bridge profile with ID profile-id
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
DELETE /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}

Get L2 Bridge Endpoint Profile


Read L2 bridge profile with ID profile-id
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}

Create or update L2 Bridge Endpoint Profile


API will create or update L2 bridge profile with ID profile-id.
L2 Bridge profile is only allowed under an enforcement-point with path
/infra/sites/default/enforcement-points/default.
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
PATCH /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}

Create or update L2 Bridge Endpoint Profile


API will create or update L2 bridge profile with ID profile-id.
L2 Bridge profile is only allowed under an enforcement-point with path
/infra/sites/default/enforcement-points/default.
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}
PUT /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-bridge-profiles/{profile-id}

List SpoofGuard profiles


API will list all SpoofGuard profiles.
GET /policy/api/v1/infra/spoofguard-profiles
GET /policy/api/v1/global-infra/spoofguard-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles

Delete SpoofGuard profile


API will delete SpoofGuard profile with the given id.
DELETE /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
DELETE /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}

Get SpoofGuard profile


API will return details of the SpoofGuard profile with given id. If the
profile does not exist, it will return 404.
GET /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
GET /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}

Patch SpoofGuard profile


Create a new SpoofGuard profile if the SpoofGuard profile with the given id
does not exist. Otherwise, patch with the existing SpoofGuard profile.
PATCH /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
PATCH /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}

Create or replace SpoofGuard profile


API will create or replace SpoofGuard profile.
PUT /policy/api/v1/infra/spoofguard-profiles/{spoofguard-profile-id}
PUT /policy/api/v1/global-infra/spoofguard-profiles/{spoofguard-profile-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/spoofguard-profiles/{spoofguard-profile-id}

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}

Get downlink port Address Resolution Protocol Proxies for tier-1 segment


Returns ARP proxy table for downlink port on connected to the segment
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy

Get downlink port Address Resolution Protocol Proxies for tier-1 segment in CSV


Returns ARP proxy table for downlink port on connected to the segment in CSV
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-proxy?format=csv

Get Tier-1 segment bridge end point statistics using segment ID and profile path.


Get detailed information on Tier-1 segment bridge end point statistics using segment ID and profile path.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-statistics

Get Tier-1 segment bridge end point status using segment ID and profile path.


Get detailed information on Tier-1 segment bridge end point status using segment ID and profile path.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/bep-status

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

Get Tier-1 segment MAC table


Returns MAC table for a segment
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table

Get Tier-1 segment MAC table in CSV


Returns MAC table for a segment
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/mac-table?format=csv

List Tier-1 segment ports


List all the ports for a Tier-1 segment.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports

Delete a Tier-1 segment port. Please note that this operation will not delete the segment port from vCenter Server if the port was connected to a Virtual Machine. Please connect Virtual Machine to another network for the segment port to be deleted from vCenter Server.


Delete a Tier-1 segment port by giving ID.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}

Get Tier-1 segment port by ID


Get detail information on a Tier-1 segment port by giving ID.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}

Patch a Tier-1 segment port


Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port
information by replacing the port object fields which presents in the request body.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}

Create or update a Tier-1 segment port


Create a Tier-1 segment port if it does not exist based on the IDs, or update existing port
information by replacing the port object already exists.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}

List all effective profiles for tier-1 segment port


List all effective profiles for this segment port on given enforcement point.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/effective-profiles

Get tier-1 segment port MAC table in CSV


Returns MAC table for a segment port
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table?format=csv

Get MAC table for tier-1 segment port


Returns MAC table for a segment port
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/mac-table

List Port Discovery Profile Binding Maps


API will list all Port Discovery Profile Binding Maps in current port id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps

Delete Port Discovery Profile Binding Profile


API will delete Port Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Get Port Discovery Profile Binding Map


API will get Port Discovery Profile Binding Map
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Create Port Discovery Profile Binding Map


API will create Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

Update Port Discovery Profile Binding Map


API will update Port Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-discovery-profile-binding-maps/{port-discovery-profile-binding-map-id}

List Port Monitoring Profile Binding Maps


API will list all Port Monitoring Profile Binding Maps in current port id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps

Delete Port Monitoring Profile Binding Profile


API will delete Port Monitoring Profile Binding Profile.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Get Port Monitoring Profile Binding Map


API will get Port Monitoring Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Create Port Monitoring Profile Binding Map


API will create Port Monitoring Profile Binding Map.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Update Port Monitoring Profile Binding Map


API will update Port Monitoring Profile Binding Map.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}

Get mirror stack status for Port Monitoring Profile Binding Map


API will get mirror stack status by Port Monitoring Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-monitoring-profile-binding-maps/{port-monitoring-profile-binding-map-id}/mirror-stack-status

List Port QoS Profile Binding Maps


API will list all Port QoS Profile Binding Maps in current port id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps

Delete Port QoS Profile Binding Profile


API will delete Port QoS Profile Binding Profile.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Get Port QoS Profile Binding Map


API will get Port QoS Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Create Port QoS Profile Binding Map


API will create Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

Update Port QoS Profile Binding Map


API will update Port QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-qos-profile-binding-maps/{port-qos-profile-binding-map-id}

List port security profile binding maps


API will list all port security profile binding maps.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps

Delete the port security profile binding map


API will delete the port security profile binding map.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Get port security profile binding map


API will return details of the port security profile binding map. If the
security profile binding map does not exist, it will return 404.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Patch port security profile binding map


Create a new port security profile binding map if the given security profile
binding map does not exist. Otherwise, patch the existing port security
profile binding map.
For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Create or replace the port security profile binding map


API will create or replace the port security profile binding map.
For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/port-security-profile-binding-maps/{port-security-profile-binding-map-id}

Get tier-1 segment port state


Returns tier-1 segment port state on enforcement point
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/ports/{port-id}/state

List Segment Discovery Profile Binding Maps


API will list all Segment Discovery Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps

Delete Segment Discovery Profile Binding Profile


API will delete Segment Discovery Profile Binding Profile
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Get Segment Discovery Profile Binding Map


API will get Segment Discovery Profile Binding Map
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Create Segment Discovery Profile Binding Map


API will create Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

Update Segment Discovery Profile Binding Map


API will update Segment Discovery Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-discovery-profile-binding-maps/{segment-discovery-profile-binding-map-id}

List Segment Monitoring Profile Binding Maps


API will list all Segment Monitoring Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps

Delete Segment Monitoring Profile Binding Profile


API will delete Segment Monitoring Profile Binding Profile.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Get Segment Monitoring Profile Binding Map


API will get Segment Monitoring Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Create Segment Monitoring Profile Binding Map


API will create segment monitoring profile binding map.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Update Segment Monitoring Profile Binding Map


API will update Segment Monitoring Profile Binding Map.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}

Get mirror stack status for Segment Monitoring Profile Binding Map


API will get mirror stack status by Segment Monitoring Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-monitoring-profile-binding-maps/{segment-monitoring-profile-binding-map-id}/mirror-stack-status

List Segment QoS Profile Binding Maps


API will list all Segment QoS Profile Binding Maps in current segment id.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps

Delete Segment QoS Profile Binding Profile


API will delete Segment QoS Profile Binding Profile.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Get Segment QoS Profile Binding Map


API will get Segment QoS Profile Binding Map.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Create Segment QoS Profile Binding Map


API will create segment QoS profile binding map. For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

Update Segment QoS Profile Binding Map


API will update Segment QoS Profile Binding Map. For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-qos-profile-binding-maps/{segment-qos-profile-binding-map-id}

List segment security profile binding maps


API will list all segment security profile binding maps.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps

Delete segment security profile binding map


API will delete segment security profile binding map.
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Get segment security profile binding map


API will return details of the segment security profile binding map. If the
binding map does not exist, it will return 404.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Patch segment security profile binding map


Create a new segment security profile binding map if the given security
profile binding map does not exist. Otherwise, patch the existing segment
security profile binding map.
For objects with no binding maps, default profile is applied.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

Create or replace segment security profile binding map


API will create or replace segment security profile binding map.
For objects with no binding maps, default profile is applied.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/segment-security-profile-binding-maps/{segment-security-profile-binding-map-id}

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

Get tier-1 segment TEP table in CSV


Returns TEP table for a segment in CSV
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table?format=csv

Get tier-1 segment TEP table


Returns TEP table for a segment
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/tep-table

Get tier-1 segment port statistics information


Get tier-1 segment port statistics information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/statistics

Get segment port status information


Get tier1 segment port status information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/ports/{port-id}/status

Get segment state information


Get tier1 segment state information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/state

Get segment statistics information


Get tier1 segment statistics information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segments-id}/statistics

Get tier-1 segments by configuration state


Returns all tier-1 segments with configuration state on the enforcement
point specified in the request
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/state