Policy > Networking > Connectivity

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

Delete evpn tunnel endpoint configuration


Delete evpn tunnel endpoint configuration.
DELETE /policy/api/v1/infra/evpn-tenant-configs/{config-id}

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}

Delete Pim Profile


Delete Pim Profile.
DELETE /policy/api/v1/infra/pim-profiles/{pim-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 prefix lists


Paginated list of all prefix lists
GET /policy/api/v1/infra/routing-config/prefix-lists

Delete a prefix list


Delete a prefix list
DELETE /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}

Read a prefix list


Read a prefix list
GET /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}

Create or patch a prefix list


If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, patch prefix list for prefix-list-id.
Note:
Patching existing prefix-list's "prefixes" property will overwrite the existing prefixes.
GET and PATCH is the expected set of operations to update or append new entries to the existig prefixes.
Patching existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
PATCH /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}

Create or update a prefix list


If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, replace the prefix list for
prefix-list-id.
Note:
Updating existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
PUT /policy/api/v1/infra/routing-config/prefix-lists/{prefix-list-id}

List project route filter lists


Paginated list of all route filter lists
GET /policy/api/v1/infra/routing-config/project-route-filters

Delete a route filter


Delete a route filter
DELETE /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}

Read a project route filter


Read a project route filter
GET /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}

Create or patch a route filter


Create or patch a route filter. This will create a mapping of projects to prefix lists. Prefix lists will be
applied to all T-1 under the specified projects.
PATCH /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-id}

Create or update project route filter


Create or update a route filter
PUT /policy/api/v1/infra/routing-config/project-route-filters/{route-filter-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 ARP table from segment interface (downlink) in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the
interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-table?format=csv

Get ARP table from segment interface (downlink)


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
interface (downlink) attaching segment to tier-0/tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/segments/{segment-id}/arp-table
GET /policy/api/v1/global-infra/segments/{segment-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/arp-table

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 ARP table for downlink router port on tier-0 router


Get ARP table for downlink router port on tier-0 router.
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-arp-table (Deprecated)

Get ARP table for downlink router port on tier-0 router in CSV


Get ARP table for downlink router port on tier-0 router in CSV.
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)

Get DAD state for downlink router port on tier-0 router


Segment ID is the ID of the segment that is connected to the the tier-0
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-dad-state

Get statistics for downlink router port on tier-0 router


Segment ID is the ID of the segment that is connected to the the tier-0
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-statistics

Get statistics for downlink router port on tier-0 router


Segment ID is the ID of the segment that is connected to the the tier-0
GET /policy/api/v1/infra/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/global-infra/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/segments/{segment-id}/gateway-interface-statistics/summary

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 Transport Zones under an Enforcement Point


Paginated list of all Transport Zones under an Enforcement Point
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones

Delete a Transport Zone under an Enforcement Point


Delete a Transport Zone under an Enforcement Point.
DELETE /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}

Read a Transport Zone under an Enforcement Point


Read a Transport Zone under an Enforcement Point
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}
GET /policy/api/v1/global-infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}

Patch a Transport Zone under an Enforcement Point


Patch a Transport Zone under an Enforcement Point
PATCH /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}

PUT a Transport Zone under an Enforcement Point


PUT a Transport Zone under an Enforcement Point
PUT /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-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}

List Tier-0s


Paginated list of all Tier-0s
GET /policy/api/v1/infra/tier-0s
GET /policy/api/v1/global-infra/tier-0s

Recover of Tier0 and linked tier1 gateway(s).


API to recover specified Tier0 gateway and linked tier1 gateway from
primary site path to new primary site path. This will update intent of
affected Tier-0 and Tier-1 gateway.
POST /policy/api/v1/infra/tier-0s?action=site_failover

Delete Tier-0


Delete Tier-0
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}

Read Tier-0


Read Tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}

Create or update a Tier-0


If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, update the Tier-0 for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}

Reprocess Tier0 gateway configuration and publish updates to NSX controller


Reprocess Tier0 gateway configuration and configuration of related entities like Tier0 interfaces
and static routes, etc. Any missing Updates are published to NSX controller.
POST /policy/api/v1/infra/tier-0s/{tier-0-id}?action=reprocess

Create or update a Tier-0


If a Tier-0 with the tier-0-id is not already present, create a new
Tier-0. If it already exists, replace the Tier-0 instance with the new object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}

Get Tier-0 Address Resolution Protocol Proxies


Returns ARP proxy table for a tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/arp-proxies
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/arp-proxies

Get Tier-0 Address Resolution Protocol Proxies in CSV format


Returns ARP proxy table for a tier-0 in CSV format
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/arp-proxies?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/arp-proxies?format=csv

List BGP community lists


Paginated list of all community lists under a tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/community-lists

Delete a BGP community list


Delete a BGP community list
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}

Read a BGP community list


Read a BGP community list
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}

Create or update a BGP community list


If a community list with the community-list-id is not already present,
create a new community list. If it already exists, update the community
list for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}

Create or update a BGP community list


If a community list with the community-list-id is not already present,
create a new community list. If it already exists, replace the community
list instance with the new object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}

Read Evpn Configuration


Read Evpn Configuration.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn

Create or Update evpn configuration


Create a evpn configuration if it is not already present,
otherwise update the evpn configuration.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn

Create or Update evpn configuration


Create or update evpn configuration.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/evpn

Get forwarding table from tier-0


Get forwarding table from tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/forwarding-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/forwarding-table

Get forwarding table from tier-0 in CSV format


Get forwarding table from tier-0 gateway in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/forwarding-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/forwarding-table?format=csv

List inter-vrf routing configurations


List all inter-vrf routing configurations.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing

Delete inter-vrf routing config


Delete inter-vrf routing config.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}

Read inter-vrf routing config


Read inter-vrf routing config.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}

Create or update inter-vrf routing config


Create or update inter-vrf routing config.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}

Create or update inter-vrf routing config


Create or update inter-vrf routing config.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}

List advertised networks


Returns information about all networks which advertised to TIER0 LR.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}/advertised-networks

List advertised networks in CSV format


List advertised networks in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}/advertised-networks?format=csv

List Tier-0 locale-services


Paginated list of all Tier-0 locale-services
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services

Get Tier-0 Address Resolution Protocol Proxies


Returns ARP proxy table for a tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)

Delete overridden BGP routing config


Deletes the specified overridden BgpRoutingConfig. If the BgpRoutingConfig
is not overridden, it won't get deleted.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp

Read BGP routing config


Read BGP routing config
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp

Create or update BGP routing config


If an BGP routing config not present, create BGP routing config.
If it already exists, update the routing config.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp

Create or update a BGP routing config


If BGP routing config is not already present, create BGP routing config.
If it already exists, replace the BGP routing config with this object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp

List BGP neighbor configurations


Paginated list of all BGP neighbor configurations
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors

Delete BGP neighbor config


Delete BGP neighbor config
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}

Read BGP neighbor config


Read BGP neighbor config
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}

Create or update a BGP neighbor config


If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}

Create or update a BGP neighbor config


If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}

Get BGP neighbor advertised routes


Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled.
The query parameter "source=cached" is not supported.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes

Get BGP neighbor advertised routes in CSV format


Returns routes advertised by BGP neighbor from all edge transport nodes on which
this neighbor is currently enabled in CSV format. Routes from all enforcement points are returned.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/advertised-routes?format=csv

Get routes learned by BGP neighbor in CSV format


Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled. Routes from all enforcement points are returned.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes?format=csv

Get routes learned by BGP neighbor


Returns routes learned by BGP neighbor from all edge nodes on which
this neighbor is currently enabled.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/{neighbor-id}/routes

Get BGP neighbor status for the Tier0


Returns the status of all the BGP neighbors for the given Tier0.
To get BGP neighbor status for a particular enforcement point,
parameter "enforcement_point_path=<enforcement_point_path>" needs to be specified.
If an enforcement_point is unspecified, then bgp neighbor status for all enforcement points is fetched.
To get BGP neighbors status for the logical router from particular edge node,
parameter "edge_path=<edge_path>" needs to be specified.
If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status

List Tier-0 Interface groups


Paginated list of all Tier-0 Interface groups under locale service.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups

Get tier-0 interface group statistics information


Get tier-0 interface group statistics information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics

Delete Tier-0 Interface group


Delete Tier-0 Interface group
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}

Read Tier-0 Interface group


Read Tier-0 Interface group
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}

Create or update a Tier-0 Interface group.


If an Interface group with the label-id is not already present, create a new
Interface group. If it already exists, update the Interface group for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}

Update a Tier-0 Interface group.


Update the Interface group for specified attributes.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interface-groups/{label-id}

List Tier-0 Interfaces


Paginated list of all Tier-0 Interfaces
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces

Delete Tier-0 interface


Delete Tier-0 interface
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
DELETE /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}

Read Tier-0 interface


Read Tier-0 interface
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}

Create or update a Tier-0 interface


If an interface with the interface-id is not already present, create a new
interface. If it already exists, update the interface for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
PATCH /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}

Create or update a Tier-0 interface


If an interface with the interface-id is not already present, create a new
interface. If it already exists, replace the interface with this object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}

Get Tier-0 Interface Address Resolution Protocol Proxies in CSV format


Returns ARP proxy table for a tier-0 interface in CSV format. Interfaces can be of types
- EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not
supported.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv

Get Tier-0 Interface Address Resolution Protocol Proxies


Returns ARP proxy table for a tier-0 interface. Interfaces can be of types
- EXTERNAL and SERVICE. Interfaces of type LOOBACK and downlink are not
supported.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy

Get ARP table from tier-0 interface in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-0 interface, on a edge node if a query parameter
"edge_path=<policy-edge-path>" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv

Get ARP table from tier-0 interface


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
tier-0 interface, on a edge node if a query parameter
"edge_path=<policy-edge-path>" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table

Get DAD status by interface


Get tier-0 interface DAD state information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state

Get tier-0 interface statistics information


Get tier-0 interface statistics information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics

Get tier-0 interface statistics summary information


Get tier-0 interface statistics summary information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary

Read OSPF routing config


Read OSPF routing config
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf

Create or update a OSPF routing config


If OSPF routing config is not already present, create OSPF routing config.
If it already exists, replace the OSPF routing config with this object.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf

Create or update a OSPF routing config


If OSPF routing config is not already present, create OSPF routing config.
If it already exists, replace the OSPF routing config with this object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf

List OSPF area configurations


List all OSPF area configurations.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas

Delete OSPF Area config


Delete OSPF Area config
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}

Read OSPF Area config


Read OSPF Area config
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}

Create or update a OSPF Area config


If OSPF Area config is not already present, create OSPF Area config.
If it already exists, replace the OSPF Area config with this object.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}

Create or update a OSPF Area config


If OSPF Area config is not already present, create OSPF Area config.
If it already exists, replace the OSPF Area config with this object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas/{area-id}

Get OSPF database information


Get OSPF database information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/database

Get OSPF Database information in CSV format


Get OSPF Database information in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/database?format=csv

Get OSPF neighbor information


Get OSPF neighbor information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/neighbors

Get OSPF route information


Get OSPF route information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/routes

Get OSPF route information in CSV format


Get OSPF route information in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/routes?format=csv

List Service Interfaces


Paginated list of all Service Interfaces
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces

Delete service interface


Delete service interface
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Read service interface


Read service interface
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Create or update a Tier-0 interface


If an interface with the interface-id is not already present, create a new
interface. If it already exists, update the interface for specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Create a service interface


If an interface with the interface-id is not already present, create a new
interface. Modification of service interface is not allowed.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

List Tier-0 Deployment maps


Paginated list of all Tier-0 Deployment Entries.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps

Delete Tier-0 Deployment Map


Delete Tier-0 Deployment Map
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}

Read a Tier-0 Deployment Map


Read a Tier-0 Deployment Map
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}

Patch a Tier-0 Deployment Map under Tier-0


If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map.
If it already exists, patch it.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}

Create a new Tier-0 Deployment Map under Tier-0


If the passed Tier-0 Deployment Map does not already exist, create a new Tier-0 Deployment Map.
If it already exists, replace it.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/tier-0-deployment-maps/{tier-0-deployment-map-id}

Delete Tier-0 locale-services


Delete Tier-0 locale-services
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}

Read Tier-0 locale-services


Read Tier-0 locale-services
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}

Create or update a tier-0 locale-services


If a Tier-0 locale-services with the locale-services-id is not already
present, create a new locale-services. If it already exists, update
Tier-0 locale-services with specified attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}

Create or update a Tier-0 locale-services


If a Tier-0 locale-services with the locale-services-id is not already
present, create a new locale-services. If it already exists, replace the
Tier-0 locale-services instance with the new object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}

List evpn tunnel endpoint configuration


List all evpn tunnel endpoint configuration.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints

Delete evpn tunnel endpoint configuration


Delete evpn tunnel endpoint configuration.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}

Read evpn tunnel endpoint configuration


Read evpn tunnel endpoint configuration.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}

Create or Update evpn tunnel endpoint configuration


Create a evpn tunnel endpoint config if the tunnel-endpoint-id is not already present,
otherwise update the tunnel endpoint configuration.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}

Create or Update evpn tunnel endpoint configuration


Create or update evpn tunnel endpoint configuration.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/evpn-tunnel-endpoints/{tunnel-endpoint-id}

Read Multicast Configuration


Read Multicast Configuration.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast

Create or update multicast configuration


Create or update a Tier-0 multicast configuration defining the multicast replication range,
the IGMP or a PIM profile. It will update the configuration if there is already one in place.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast

Create or update multicast configuration


Create or update a Tier-0 multicast configuration defining the multicast replication range,
the IGMP or a PIM profile. It will update the configuration if there is already one in place.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast

Get Multicast Forwarding In Csv Format


Get Multicast Forwarding In CSV Format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/forwarding?format=csv

Get Multicast Forwarding


Get Multicast Forwarding.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/forwarding

Get IGMP Memberships in CSV format


Get Igmp Memberships in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships?format=csv

Get IGMP Memberships


Get Igmp Memberships.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/igmp-memberships

Get PIM Rendezvous Point Mappings In CSV Format


Get PIM Rendezvous Point Mappings In CSV Format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/pim-rp-mappings?format=csv

Get PIM Rendezvous Point Mappings


Get PIM Rendezvous Point Mappings.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/pim-rp-mappings

Get Multicast Routes in Csv Format


Get Multicast Routes in CSV Format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/routes?format=csv

Get Multicast Routes


Get Multicast Routes.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-services-id}/multicast/routes

List Tunnel


List Tunnel
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels

Delete Tunnel by given tunnel Id


Delete Tunnel by given tunnel Id
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}

Get Policy Tunnel


Get Policy Tunnel
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}

Patch Tunnel


Patch Tunnel
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}

Create or Update Tunnel


Create or Update Tunnel
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}

Get policy Tunnel statistics for given tunnel-id


Get policy Tunnel statistics for given tunnel-id
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics

Get policy Tunnel statistics summary for given tunnel-id


Get policy Tunnel statistics summary for given tunnel-id
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/statistics/summary

Get policy Tunnel status for given tunnel-id


Get policy Tunnel status for given tunnel-id
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-svc-id}/tunnels/{tunnel-id}/status

Get total number of IPv4 or IPv6 routes on a Tier0


Get total number of IPv4 or IPv6 routes on a Tier0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/number-of-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/number-of-routes

List prefix lists


Paginated list of all prefix lists
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/prefix-lists

Delete a prefix list


Delete a prefix list
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}

Read a prefix list


Read a prefix list
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}

Create or patch a prefix list


If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, patch prefix list for prefix-list-id.
Note:
Patching existing prefix-list's "prefixes" property will overwrite the existing prefixes.
GET and PATCH is the expected set of operations to update or append new entries to the existig prefixes.
Patching existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}

Create or update a prefix list


If prefix list for prefix-list-id is not already present, create
a prefix list. If it already exists, replace the prefix list for
prefix-list-id.
Note:
Updating existing prefixes require order to be preserved to avoid traffic impact. During PATCH operation,
reordering of existing prefixes may impact routes and eventually datapath.
Order here is crucial and it all depends upon action. If action for every prefix is PERMIT then order may
not impact but if there is DENY prefix then change in ordering could lead to traffic impact.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}

List route maps


Paginated list of all route maps under a tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/route-maps

Delete a route map


Delete a route map
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}

Read a route map


Read a route map
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}

Create or update a route map


If a route map with the route-map-id is not already present, create a new
route map. If it already exists, update the route map for specified
attributes.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}

Create or update a route map


If a route map with the route-map-id is not already present,
create a new route map. If it already exists, replace the
route map instance with the new object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}

Get routing table from tier-0


Get routing table from tier-0
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/routing-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/routing-table

Get routing table from tier-0 in CSV format


Get routing table from tier-0 gateway in CSV format.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/routing-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/routing-table?format=csv

Get Tier0 state


Returns
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/state
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/state

List Tier-0 Static Routes


Paginated list of all Tier-0 Static Routes
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes

Delete Tier-0 static routes


Delete Tier-0 static routes
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}

Read Tier-0 static routes


Read Tier-0 static routes
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}

Create or update a Tier-0 static routes


If static routes for route-id are not already present, create
static routes. If it already exists, update static routes for route-id.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}

Create or update a Tier-0 static routes


If static routes for route-id are not already present, create
static routes. If it already exists, replace the static routes for route-id.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
PUT /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/{route-id}

List StaticRouteBfdPeers


Paginated list of all StaticRouteBfdPeers.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers

Delete this StaticRouteBfdPeer and all the entities contained by it.


Delete this StaticRouteBfdPeer and all the entities contained by it.
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}

Read a StaticRouteBfdPeer


Read a StaticRouteBfdPeer with the bfd-peer-id.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}

Create or update a StaticRouteBfdPeer


If a StaticRouteBfdPeer with the bfd-peer-id is not already present,
create a new StaticRouteBfdPeer. If it already exists, update the
StaticRouteBfdPeer. This is a full replace.
PATCH /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}

Create or update a StaticRouteBfdPeer


If a StaticRouteBfdPeer with the bfd-peer-id is not already present,
create a new StaticRouteBfdPeer. If it already exists, update the
StaticRouteBfdPeer. This operation will fully replace the object.
PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/bfd-peers/{bfd-peer-id}

Get tier-0 router link arp information


Get tier-0 interface arp information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table

Get ARP table from tier-0 router link interface in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-0 router link interface, on a edge node. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/arp-table?format=csv

Get tier-0 router link statistics information


Get tier-0 interface statistics information.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics

Get tier-0 router link statistics summary information


Get tier-0 interface statistics summary information. In case tier 1 is A/A, and the edge cluster is not
the response will have interface_policy_path and logical_router_port_id empty because all logical router
port stats are aggregated from all edge nodes.
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-0s/{tier-0-id}/tier-1-interface/statistics/summary

List Tier-1 instances


Paginated list of all Tier-1 instances
GET /policy/api/v1/infra/tier-1s
GET /policy/api/v1/global-infra/tier-1s
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s

Delete Tier-1 configuration


Delete Tier-1 configuration
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}

Read Tier-1 configuration


Read Tier-1 configuration
GET /policy/api/v1/infra/tier-1s/{tier-1-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}

Create or update Tier-1 configuration


If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance.
If it already exists, update the tier-1 instance with specified attributes.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}

Reprocess Tier1 gateway configuration and publish updates to NSX controller


Reprocess Tier1 gateway configuration and configuration of related entities like Tier1 interfaces
and static routes, etc. Any missing Updates are published to NSX controller.
POST /policy/api/v1/infra/tier-1s/{tier-1-id}?action=reprocess
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}?action=reprocess

Create or update tier-1 configuration


If Tier-1 with the tier-1-id is not already present, create a new Tier-1 instance.
If it already exists, replace the Tier-1 instance with this object.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}

List advertised networks


Return networks which are advertised to connected TIER0 gateway.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/advertised-networks
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/advertised-networks
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/advertised-networks

List advertised networks in CSV format


Return networks which are advertised to connected TIER0 gateway in CSV format.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/advertised-networks/csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/advertised-networks/csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/advertised-networks/csv

Get Tier-1 Address Resolution Protocol Proxies


Returns ARP proxy table for a tier-1
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/arp-proxies
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/arp-proxies
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/arp-proxies

Get Tier-1 Address Resolution Protocol Proxies in CSV format


Returns ARP proxy table for a tier-1 in CSV format
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/arp-proxies?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/arp-proxies?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/arp-proxies?format=csv

Get forwarding table from tier-1 in CSV format


Get forwarding table from tier-1 gateway in CSV format.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/forwarding-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/forwarding-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/forwarding-table?format=csv

Get forwarding table from tier-1


Get forwarding table from tier-1
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/forwarding-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/forwarding-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/forwarding-table

List Tier-1 locale-services


Paginated list of all Tier-1 locale-services
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services

Get Tier-1 Address Resolution Protocol Proxies


Get Tier-1 Address Resolution Protocol Proxies.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/arp-proxies (Deprecated)

List Tier-1 Interface groups


Paginated list of all Tier-1 Interface groups under locale service.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups

Delete Tier-1 Interface group


Delete Tier-1 Interface group
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}

Read Tier-1 Interface group


Read Tier-1 Interface group
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}

Create or update a Tier-1 Interface group.


If an Interface group with the label-id is not already present, create a new
Interface group. If it already exists, update the Interface group for specified attributes.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}

Update a Tier-1 Interface group.


Update the Interface group for specified attributes.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{group-id}

Get tier-1 interface group statistics information


Get tier-1 interface group statistics information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interface-groups/{interface-group-id}/statistics

Get Tier-1 Interface Address Resolution Protocol Proxies in CSV format


Returns ARP proxy table for a tier-1 interface in CSV format
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy?format=csv

Get Tier-1 Interface Address Resolution Protocol Proxies


Returns ARP proxy table for a tier-1 interface
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-proxy

Get ARP table from tier-1 interface


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
tier-1 interface, on a edge node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table

Get ARP table from tier-1 interface in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-1 interface, on a edge node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/arp-table?format=csv

Get DAD status by interface


Get tier-1 interface DAD state information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/dad-state

Get tier-1 interface statistics information


Get tier-1 interface statistics information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics

Get tier-1 interface statistics summary information


Get tier-1 interface statistics information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/interfaces/{interface-id}/statistics/summary

List Tier 1 Service Interfaces


Paginated list of all Tier 1 Service Interfaces
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces

Delete Tier 1 service interface


Delete Tier 1 service interface
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Read Tier 1 service interface


Read Tier 1 service interface
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Create or update a Tier-1 service interface


If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service
interface.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Create a Tier1 service interface


If a Tier1 service interface with the interface-id is not already present, create a new Tier1 service
interface. Modification of Tier 1 service interface is not allowed.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-service-id}/service-interfaces/{interface-id}

Delete Tier-1 locale-services


Delete Tier-1 locale-services
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}

Read Tier-1 locale-services


Read Tier-1 locale-services
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}

Create or update a Tier-1 locale-services


If a Tier-1 locale services with the locale-services-id is not already
present, create a new locale services. If it already exists, update
Tier-1 locale services with specified attributes.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}

Create or update a Tier-1 locale-services


If a Tier-1 locale services with the locale-services-id is not already
present, create a new locale-services. If it already exists, replace the
Tier-1 locale services instance with the new object.

Modifying edge cluster re-allocates NSX service routers of TIER1 to a different edge
cluster. You can also place edge nodes manually and provide maximum two indices
for HA mode ACTIVE_STANDBY. To re-allocating edge cluster is a disruptive operation
and all existing statistics of Tier1 gateway will be removed.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}

List Tier-1 interfaces


Paginated list of all Tier-1 interfaces
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces

Delete Tier-1 interface


Delete Tier-1 interface
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}

Read Tier-1 interface


Read Tier-1 interface
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}

Create or update a Tier-1 interface


If an interface with the interface-id is not already present, create a new
interface. If it already exists, update the interface for specified
attributes.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}

Create or update a tier-1 interface


If an interface with the interface-id is not already present, create a new
interface. If it already exists, replace the interface with this object.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/interfaces/{interface-id}

Read Multicast Configuration


Read Multicast Configuration.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast

Create or update multicast configuration


Create or update a Tier-1 multicast configuration defining the multicast replication range.
It will update the configuration if there is already one in place.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast

Create or update multicast configuration


Create or update a Tier-1 multicast configuration defining the multicast replication range.
It will update the configuration if there is already one in place.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast

Get Multicast Forwarding In Csv Format


Get Multicast Forwarding In CSV Format.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/forwarding?format=csv

Get Multicast Forwarding


Get Multicast Forwarding.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/forwarding

Get IGMP Memberships in CSV format


Get Igmp Memberships in CSV format.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/igmp-memberships?format=csv

Get IGMP Memberships


Get Igmp Memberships.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/locale-services/{locale-services-id}/multicast/igmp-memberships

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 ARP table from segment interface (downlink) in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format for the
interface (downlink) attaching segment to tier1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table?format=csv

Get ARP table from segment interface (downlink)


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) for the
interface (downlink) attaching segment to tier-1 gateway, on a edge
node specified in edge_path parameter.
The edge_path parameter is mandatory.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/arp-table

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 ARP table for downlink router port on tier-1 router


Get ARP table for downlink router port on tier-1 router.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table (Deprecated)

Get ARP table for downlink router port on tier-1 router in CSV


Get ARP table for downlink router port on tier-1 router in CSV.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-arp-table?format=csv (Deprecated)

Get DAD state for downlink router port on tier-1 router


Segment ID is the ID of the segment that is connected to the the tier-1
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-dad-state

Get statistics for downlink router port on tier-1 router


Segment ID is the ID of the segment that is connected to the the tier-1
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics

Get statistics for downlink router port on tier-1 router


Segment ID is the ID of the segment that is connected to the the tier-1
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/segments/{segment-id}/gateway-interface-statistics/summary

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

Get Tier1 state


Returns
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/state
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/state
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/state

List Tier-1 Static Routes


Paginated list of all Tier-1 Static Routes
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/static-routes
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes

Delete Tier-1 static routes


Delete Tier-1 static routes
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}

Read Tier-1 static routes


Read Tier-1 static routes
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/static-routes/{route-id}
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}

Create or update a Tier-1 static routes


If static routes for route-id are not already present, create
static routes. If it already exists, update static routes for route-id.
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}

Create or update a Tier-1 static routes


If static routes for route-id are not already present, create
static routes. If it already exists, replace the static routes for route-id.
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/static-routes/{route-id}
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/static-routes/{route-id}

Get ARP table from tier-1 router link interface in CSV format


Returns ARP table (IPv4) or Neighbor Discovery table (IPv6) in CSV format
for the tier-1 router link interface.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table?format=csv

Get tier-1 router link arp information


Get tier-1 interface arp information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/arp-table

Get tier-1 router link statistics information


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

Get tier-1 router link statistics summary information


Get tier-1 interface statistics summary information.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/tier-0-interface/statistics/summary