Policy > Networking

Associated URIs:

API Description API Path

List BfdProfiles


Paginated list of all BfdProfiles.
GET /global-manager/api/v1/global-infra/bfd-profiles

Delete BFD Config and all the entities contained by this BfdProfile


Delete BFD Config and all the entities contained by this BfdProfile.
DELETE /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>

Read a BfdProfile


Read a BfdProfile.
GET /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>

Create or update a BfdProfile


If a BfdProfile with the bfd-profile-id is not already present,
create a new BfdProfile. If it already exists, update the
BfdProfile. This operation will fully replace the object.
PATCH /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>

Create or update a BfdProfile


If a BfdProfile with the bfd-profile-id is not already present,
create a new BfdProfile. If it already exists, update the
BfdProfile. This operation will fully replace the object.
PUT /global-manager/api/v1/global-infra/bfd-profiles/<bfd-profile-id>

List DHCP relay config instances


Paginated list of all DHCP relay config instances
GET /global-manager/api/v1/global-infra/dhcp-relay-configs

Delete DHCP relay configuration


Delete DHCP relay configuration
DELETE /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>

Read DHCP relay configuration


Read DHCP relay configuration
GET /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>

Create or update DHCP relay configuration


If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance.
If it already exists, update the DHCP relay config instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>

Create or update DHCP relay configuration


If DHCP relay config with the dhcp-relay-config-id is not already present,
create a new DHCP relay config instance. If it already exists, replace
the DHCP relay config instance with this object.
PUT /global-manager/api/v1/global-infra/dhcp-relay-configs/<dhcp-relay-config-id>

List DHCP server config instances


Paginated list of all DHCP server config instances
GET /global-manager/api/v1/global-infra/dhcp-server-configs

Read DHCP server leases


Read DHCP server leases
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/leases

Read DHCP server state


Read DHCP server state
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/state

Read DHCP server statistics


Read DHCP server statistics
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/stats

Read DHCP server status


Read DHCP server status
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<config-id>/status

Delete DHCP server configuration


Delete DHCP server configuration
DELETE /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>

Read DHCP server configuration


Read DHCP server configuration
GET /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>

Create or update DHCP server configuration


If DHCP server config with the dhcp-server-config-id is not already
present, create a new DHCP server config instance. If it already exists,
update the DHCP server config instance with specified attributes.

Realized entities of this API can be found using the path of Tier-0, Tier1,
or Segment where this config is applied on.

Modification of edge_cluster_path in DhcpServerConfig will lose all
existing DHCP leases.

If both the preferred_edge_paths in the DhcpServerConfig are changed
in a same PATCH API, e.g. change from [a,b] to [x,y], the current DHCP
server leases will be lost, which could cause network connectivity
issues. It is recommended to change only one member index in an update
call, e.g. from [a, b] to [a,y].

Clearing preferred_edge_paths will not reassign edge nodes from the
edge cluster. Instead, the previously-allocated edge nodes will be
retained to avoid loss of leases.
PATCH /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>

Create or update DHCP server configuration


If DHCP server config with the dhcp-server-config-id is not already
present, create a new DHCP server config instance. If it already exists,
replace the DHCP server config instance with this object.

Realized entities of this API can be found using the path of Tier-0, Tier1,
or Segment where this config is applied on.

Modification of edge_cluster_path in DhcpServerConfig will lose all
existing DHCP leases.

If both the preferred_edge_paths in the DhcpServerConfig are changed
in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP
server leases will be lost, which could cause network connectivity
issues. It is recommended to change only one member index in an update
call, e.g. from [a, b] to [a,y].

Clearing preferred_edge_paths will not reassign edge nodes from the
edge cluster. Instead, the previously-allocated edge nodes will be
retained to avoid loss of leases.
PUT /global-manager/api/v1/global-infra/dhcp-server-configs/<dhcp-server-config-id>

List Dns Forwarder Zones


Paginated list of all Dns Forwarder Zones
GET /global-manager/api/v1/global-infra/dns-forwarder-zones

Delete the DNS Forwarder Zone


Delete the DNS Forwarder Zone
DELETE /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>

Read the DNS Forwarder Zone


Read the DNS Forwarder Zone
GET /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>

Create or update the DNS Forwarder Zone


Create or update the DNS Forwarder Zone
PATCH /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>

Create or update the DNS Forwarder Zone


Create or update the DNS Forwarder Zone
PUT /global-manager/api/v1/global-infra/dns-forwarder-zones/<dns-forwarder-zone-id>

List forwarding policies for the given domain


List all forwarding policies for the given domain ordered by precedence.
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies

Read forwarding policy


Read forwarding policy.
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>

List rules


List rules
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules

Read rule


Read rule
GET /global-manager/api/v1/global-infra/domains/<domain-id>/forwarding-policies/<forwarding-policy-id>/rules/<rule-id>

List all gateway QoS profiles


Paginated list of all gateway QoS profle instances
GET /global-manager/api/v1/global-infra/gateway-qos-profiles

Delete gateway QoS profile


Delete QoS profile
DELETE /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>

Read gateway QoS profile


Read gateway QoS profile
GET /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>

Create or update Gateway QoS profile


If profile with the qos-profile-id is not already present,
create a new gateway QoS profile instance. If it already exists, update
the gateway QoS profile instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>

Create or update Gateway QoS profile


If profile with the qos-profile-id is not already present,
create a new gateway QoS profile instance. If it already exists, replace
the gateway QoS profile instance with this object.
PUT /global-manager/api/v1/global-infra/gateway-qos-profiles/<qos-profile-id>

List IP Discovery Profiles


API will list all IP Discovery Profiles active in current discovery profile id.
GET /global-manager/api/v1/global-infra/ip-discovery-profiles

Delete IP Discovery Profile


API will delete IP Discovery profile.
DELETE /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>

Get IP Discovery Profile


API will get IP Discovery profile.
GET /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>

Create IP Discovery Profile


API will create IP Discovery profile.
PATCH /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>

Update IP Discovery Profile


API will update IP Discovery profile.
PUT /global-manager/api/v1/global-infra/ip-discovery-profiles/<ip-discovery-profile-id>

List all IPv6 DAD profiles


Paginated list of all IPv6 DAD profile instances
GET /global-manager/api/v1/global-infra/ipv6-dad-profiles

Delete IPv6 DAD profile


Delete IPv6 DAD profile
DELETE /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>

Read IPv6 DAD profile


Read IPv6 DAD profile
GET /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>

Create or update IPv6 DAD profile


If profile with the dad-profile-id is not already present,
create a new IPv6 DAD profile instance. If it already exists, update
the IPv6 DAD profile instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>

Create or update IPv6 DAD profile


If profile with the dad-profile-id is not already present,
create a new IPv6 DAD profile instance. If it already exists, replace
the IPv6 DAD profile instance with this object.
PUT /global-manager/api/v1/global-infra/ipv6-dad-profiles/<dad-profile-id>

List all IPv6 NDRA profiles


Paginated list of all IPv6 NDRA profile instances
GET /global-manager/api/v1/global-infra/ipv6-ndra-profiles

Delete IPv6 NDRA profile


Delete IPv6 NDRA profile
DELETE /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>

Read IPv6 NDRA profile


Read IPv6 NDRA profile
GET /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>

Create or update IPv6 NDRA profile


If profile with the ndra-profile-id is not already present,
create a new IPv6 NDRA profile instance. If it already exists, update
the IPv6 NDRA profile instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>

Create or update IPv6 NDRA profile


If profile with the ndra-profile-id is not already present,
create a new IPv6 NDRA profile instance. If it already exists, replace
the IPv6 NDRA profile instance with this object.
PUT /global-manager/api/v1/global-infra/ipv6-ndra-profiles/<ndra-profile-id>

List Mac Discovery Profiles


API will list all Mac Discovery Profiles active in current discovery profile id.
GET /global-manager/api/v1/global-infra/mac-discovery-profiles

Delete Mac Discovery Profile


API will delete Mac Discovery profile.
DELETE /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>

Get Mac Discovery Profile


API will get Mac Discovery profile.
GET /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>

Create Mac Discovery Profile


API will create Mac Discovery profile.
PATCH /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>

Update Mac Discovery Profile


API will update Mac Discovery profile.
PUT /global-manager/api/v1/global-infra/mac-discovery-profiles/<mac-discovery-profile-id>

List QoS Profiles


API will list all QoS profiles.
GET /global-manager/api/v1/global-infra/qos-profiles

Delete QoS profile


API will delete QoS profile.
DELETE /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>

Details of QoS profile


API will return details of QoS profile.
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>

Create or Replace QoS profile.


Create or Replace QoS profile.
PUT /global-manager/api/v1/global-infra/qos-profiles/<qos-profile-id>

List segment security profiles


API will list all segment security profiles.
GET /global-manager/api/v1/global-infra/segment-security-profiles

DELETE segment security profile


API will delete segment security profile with the given id.
DELETE /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>

PUT segment security profile id


Create or replace a segment security profile
PUT /global-manager/api/v1/global-infra/segment-security-profiles/<segment-security-profile-id>

List all segments under infra


Paginated list of all segments under infra.
GET /global-manager/api/v1/global-infra/segments

List Infra Port Discovery Profile Binding Maps


API will list all Infra Port Discovery Profile Binding Maps in current port id.
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-discovery-profile-binding-maps

Get Infra Port Discovery Profile Binding Map


API will get Infra Port Discovery Profile Binding Map
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps

Get Infra Port Monitoring Profile Binding Map


API will get Infra Port Monitoring Profile Binding Map.
GET /global-manager/api/v1/global-infra/segments/<infra-segment-id>/ports/<infra-port-id>/port-monitoring-profile-binding-maps/<port-monitoring-profile-binding-map-id>

List Infra Segment Discovery Profile Binding Maps


API will list all Infra Segment Discovery Profile Binding Maps in current segment id.
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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
PATCH /global-manager/api/v1/global-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
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/segments/<infra-segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>

Delete infra segment


Delete infra segment
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>

Force delete infra segment


Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity.
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>?force=true

Read infra segment


Read infra segment
GET /global-manager/api/v1/global-infra/segments/<segment-id>

Create or update a segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.
PATCH /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/segments/<segment-id>?force=true

Create or update a infra segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.
PUT /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-infra/segments/<segment-id>?force=true

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 /global-manager/api/v1/global-infra/segments/<segment-id>/arp-table

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 /global-manager/api/v1/global-infra/segments/<segment-id>/arp-table?format=csv

List all DHCP static bindings


Paginated list of all DHCP static binding instances
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs

Delete DHCP static binding


Delete DHCP static binding
DELETE /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Read DHCP static binding


Read DHCP static binding
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Create or update DHCP static binding


If binding with the binding-id is not already present,
create a new DHCP static binding instance. If it already exists, replace
the existing DHCP static binding instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Create or update DHCP static binding


If binding with the binding-id is not already present,
create a new DHCP static binding instance. If it already exists, replace
the existing DHCP static binding instance with this object.
PUT /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Read DHCP static binding state


Read DHCP static binding state
GET /global-manager/api/v1/global-infra/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state

Get infra segment cross site forwarder placement and HA status


Get infra segment cross site forwarder placement and HA statuss.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/site-span-info

Get infra segment cross site traffic statistics


Get infra segment cross site traffic statistics.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/inter-site-forwarder/status

List infra segment ports


List all the ports for an infra.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports

Get infra segment port by ID


Get detail information on an infra segment port by giving ID.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>

List Port QoS Profile Binding Maps


API will list all Port QoS Profile Binding Maps in current port id.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps

Get Port QoS Profile Binding Map


API will get Port QoS Profile Binding Map.
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps

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 /global-manager/api/v1/global-infra/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps/<port-security-profile-binding-map-id>

List Segment QoS Profile Binding Maps


API will list all Segment QoS Profile Binding Maps in current segment id.
GET /global-manager/api/v1/global-infra/segments/<segment-id>/segment-qos-profile-binding-maps

Delete Segment QoS Profile Binding Profile


API will delete Segment QoS Profile Binding Profile.
DELETE /global-manager/api/v1/global-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 /global-manager/api/v1/global-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.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-infra/segments/<segment-id>/segment-security-profile-binding-maps/<segment-security-profile-binding-map-id>

Get infra segment port statistics information


Get infra segment port statistics information.
GET /global-manager/api/v1/global-infra/segments/<segments-id>/ports/<port-id>/statistics

Get infra segment state information


Get infra segment state information.
GET /global-manager/api/v1/global-infra/segments/<segments-id>/state

Get infra segment statistics information


Get infra segment statistics information.
GET /global-manager/api/v1/global-infra/segments/<segments-id>/statistics

List SpoofGuard profiles


API will list all SpoofGuard profiles.
GET /global-manager/api/v1/global-infra/spoofguard-profiles

Delete SpoofGuard profile


API will delete SpoofGuard profile with the given id.
DELETE /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>

Create or replace SpoofGuard profile


API will create or replace SpoofGuard profile.
PUT /global-manager/api/v1/global-infra/spoofguard-profiles/<spoofguard-profile-id>

List Tier-0s


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

Delete Tier-0


Delete Tier-0
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>

Read Tier-0


Read Tier-0
GET /global-manager/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 /global-manager/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, replace the Tier-0 instance with the new object.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>

List BGP community lists


Paginated list of all community lists under a tier-0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists

Delete a BGP community list


Delete a BGP community list
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>

Read a BGP community list


Read a BGP community list
GET /global-manager/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 /global-manager/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, replace the community
list instance with the new object.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/community-lists/<community-list-id>

Delete DNS configuration for tier-0 instance


Delete DNS configuration for tier-0 instance
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder

Read the DNS Forwarder for the given tier-0 instance


Read the DNS Forwarder for the given tier-0 instance
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder

Update the DNS Forwarder


Update the DNS Forwarder
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder

Perform the specified DNS forwarder action


Perform the specified action for Tier0 DNS forwarder on specified enforcement point.
POST /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder

Update the DNS Forwarder


Update the DNS Forwarder
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder

Resolve a given address via the dns forwarder at Tier0


Query the nameserver for an ip-address or a FQDN of the given an address optionally using
an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it.
If the address is an ip-address, do a reverse lookup and answer fqdn(s).
If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from
specified enforcement point. Otherwise from all enforcement points.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/nslookup

Get tier-0 DNS forwarder statistics


Get statistics of tier-0 DNS forwarder.
- no enforcement point path specified: Statistics will be evaluated on each enforcement
point.
- {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/statistics

Get current status of tier-0 DNS forwarder


Get current status of tier-0 DNS forwarder.
- no enforcement point path specified: Status will be evaluated on each enforcement
point.
- {enforcement_point_path}: Status will be evaluated only on the given enforcement
point.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/dns-forwarder/status

Get forwarding table from tier-0 in CSV format


Get forwarding table from tier-0 gateway in CSV format.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table?format=csv

Get forwarding table from tier-0


Get forwarding table from tier-0
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/forwarding-table

List Tier-0 locale-services


Paginated list of all Tier-0 locale-services
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services

Read BGP routing config


Read BGP routing config
GET /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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=" 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=" needs to be specified.
If an edge_path is unspecified, then bgp neighbor status for all edges is fetched.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/status

List Tier-0 Interfaces


Paginated list of all Tier-0 Interfaces
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces

Delete Tier-0 interface


Delete Tier-0 interface
DELETE /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>

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=" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table

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=" is given. The edge_path
parameter is mandatory if the interface type is not EXTERNAL.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/arp-table?format=csv

Get DAD status by interface


Get tier-0 interface DAD state information.
GET /global-manager/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 /global-manager/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 /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary

List Service Interfaces


Paginated list of all Service Interfaces
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces

Delete service interface


Delete service interface
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/service-interfaces/<interface-id>

Read service interface


Read service interface
GET /global-manager/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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/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 /global-manager/api/v1/global-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 /global-manager/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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>

Read Tier-0 locale-services


Read Tier-0 locale-services
GET /global-manager/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 /global-manager/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, replace the
Tier-0 locale-services instance with the new object.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>

Get RTEP span and mac address-table


Get RTEP span and mac address-table.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/bgp-summary

Get RTEP mesh connectivity status


Get RTEP mesh connectivity status.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-services-id>/inter-site/status

List NAT Rules


List NAT Rules from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules

Delete NAT Rule


Delete NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule


Get NAT Rule from Tier-0 denoted by Tier-0 ID, under NAT section
denoted by <nat-id>.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Create or update a NAT Rule on tier-0


If a NAT Rule is not already present on Tier-0 denoted by Tier-0 ID,
under NAT section denoted by <nat-id>, create a new NAT Rule.
If it already exists, update the NAT Rule.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
PATCH /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Update NAT Rule


Update NAT Rule on Tier-0 denoted by Tier-0 ID, under NAT section denoted by <nat-id>. Under tier-0 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule Statistics


Get NAT Rule Statistics from Tier-0 denoted by Tier-0 ID, under NAT section
denoted by <nat-id>.
Under tier-0 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics

List NAT Rules Statistics


List NAT Rules Statistics from Tier-0 denoted by Tier-0 ID.
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/nat/statistics

List prefix lists


Paginated list of all prefix lists
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists

Delete a prefix list


Delete a prefix list
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/prefix-lists/<prefix-list-id>

Read a prefix list


Read a prefix list
GET /global-manager/api/v1/global-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, update prefix list for prefix-list-id.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps

Delete a route map


Delete a route map
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>

Read a route map


Read a route map
GET /global-manager/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 /global-manager/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, replace the
route map instance with the new object.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/route-maps/<route-map-id>

Get routing table from tier-0


Get routing table from tier-0
GET /global-manager/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 /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/routing-table?format=csv

Get Tier0 state


Returns
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/state

List Tier-0 Static Routes


Paginated list of all Tier-0 Static Routes
GET /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes

Delete Tier-0 static routes


Delete Tier-0 static routes
DELETE /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>

Read Tier-0 static routes


Read Tier-0 static routes
GET /global-manager/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 /global-manager/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, replace the static routes for route-id.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/<route-id>

List StaticRouteBfdPeers


Paginated list of all StaticRouteBfdPeers.
GET /global-manager/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 /global-manager/api/v1/global-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 /global-manager/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 /global-manager/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 operation will fully replace the object.
PUT /global-manager/api/v1/global-infra/tier-0s/<tier-0-id>/static-routes/bfd-peers/<bfd-peer-id>

List Tier-1 instances


Paginated list of all Tier-1 instances
GET /global-manager/api/v1/global-infra/tier-1s

Delete Tier-1 configuration


Delete Tier-1 configuration
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>

Read Tier-1 configuration


Read Tier-1 configuration
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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, replace the Tier-1 instance with this object.
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>

Delete DNS configuration for tier-1 instance


Delete DNS configuration for tier-1 instance
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder

Read the DNS Forwarder for the given tier-1 instance


Read the DNS Forwarder for the given tier-1 instance
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder

Create or update the DNS Forwarder


Create or update the DNS Forwarder
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder

Perform the specified DNS forwarder action


Perform the specified action for Tier0 DNS forwarder on specified enforcement point.
POST /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder

Create or update the DNS Forwarder


Create or update the DNS Forwarder
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder

Resolve a given address via the dns forwarder at Tier1


Query the nameserver for an ip-address or a FQDN of the given an address optionally using
an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it.
If the address is an ip-address, do a reverse lookup and answer fqdn(s).
If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from
specified enforcement point. Otherwise from all enforcement points.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/nslookup

Get tier-1 DNS forwarder statistics


Get statistics of tier-1 DNS forwarder.
- no enforcement point path specified: Statistics will be evaluated on each enforcement
point.
- {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/statistics

Get current status of tier-1 DNS forwarder


Get current status of tier-1 DNS forwarder.
- no enforcement point path specified: Status will be evaluated on each enforcement
point.
- {enforcement_point_path}: Status will be evaluated only on the given enforcement
point.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/dns-forwarder/status

Get forwarding table from tier-1 in CSV format


Get forwarding table from tier-1 gateway in CSV format.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table?format=csv

Get forwarding table from tier-1


Get forwarding table from tier-1
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/forwarding-table

List Tier-1 locale-services


Paginated list of all Tier-1 locale-services
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services

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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-service-id>/interfaces/<interface-id>/statistics/summary

Delete Tier-1 locale-services


Delete Tier-1 locale-services
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>

Read Tier-1 locale-services


Read Tier-1 locale-services
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>

List Tier-1 interfaces


Paginated list of all Tier-1 interfaces
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces

Delete Tier-1 interface


Delete Tier-1 interface
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>

Read Tier-1 interface


Read Tier-1 interface
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/locale-services/<locale-services-id>/interfaces/<interface-id>

List NAT Rules


List NAT Rules from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules

Delete NAT Rule


Delete NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule


Get NAT Rule from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by <nat-id>.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Create or update a Nat Rule


If a NAT Rule is not already present on Tier-1 denoted by Tier-1 ID,
under NAT section denoted by <nat-id>, create a new NAT Rule.
If it already exists, update the NAT Rule.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Update NAT Rule


Update NAT Rule on Tier-1 denoted by Tier-1 ID, under NAT section denoted by <nat-id>. Under tier-1 there will be 3 different NATs(sections). (INTERNAL, USER and DEFAULT) For more details related to NAT section please refer to PolicyNAT schema.
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>

Get NAT Rule Statistics


Get NAT Rule Statistics from Tier-1 denoted by Tier-1 ID, under NAT section
denoted by <nat-id>.
Under tier-1 there will be 3 different NATs(sections).
(INTERNAL, USER and DEFAULT)
For more details related to NAT section please refer to PolicyNAT schema.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/<nat-id>/nat-rules/<nat-rule-id>/statistics

List NAT Rules Statistics


List NAT Rules Statistics from Tier-1 denoted by Tier-1 ID.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/nat/statistics

List all segments under tier-1 instance


Paginated list of all segments under Tier-1 instance
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments

Delete segment


Delete segment
DELETE /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>?force=true

Read segment


Read segment
GET /global-manager/api/v1/global-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.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>

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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table

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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/arp-table?format=csv

List all DHCP static bindings


Paginated list of all DHCP static binding instances
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs

Delete DHCP static binding


Delete DHCP static binding
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Read DHCP static binding


Read DHCP static binding
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Create or update DHCP static binding


If binding with the binding-id is not already present,
create a new DHCP static binding instance. If it already exists, replace
the existing DHCP static binding instance with specified attributes.
PATCH /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Create or update DHCP static binding


If binding with the binding-id is not already present,
create a new DHCP static binding instance. If it already exists, replace
the existing DHCP static binding instance with this object.
PUT /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-binding-configs/<binding-id>

Read DHCP static binding state


Read DHCP static binding state
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/dhcp-static-bindings/<binding-id>/state

List Tier-1 segment ports


List all the ports for a Tier-1 segment.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports

Get Tier-1 segment port by ID


Get detail information on a Tier-1 segment port by giving ID.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>

List Port Discovery Profile Binding Maps


API will list all Port Discovery Profile Binding Maps in current port id.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-discovery-profile-binding-maps

Get Port Discovery Profile Binding Map


API will get Port Discovery Profile Binding Map
GET /global-manager/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>

List Port Monitoring Profile Binding Maps


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

Get Port Monitoring Profile Binding Map


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

List Port QoS Profile Binding Maps


API will list all Port QoS Profile Binding Maps in current port id.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-qos-profile-binding-maps

Get Port QoS Profile Binding Map


API will get Port QoS Profile Binding Map.
GET /global-manager/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>

List port security profile binding maps


API will list all port security profile binding maps.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/ports/<port-id>/port-security-profile-binding-maps

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 /global-manager/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>

List Segment Discovery Profile Binding Maps


API will list all Segment Discovery Profile Binding Maps in current segment id.
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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
PATCH /global-manager/api/v1/global-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
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/segment-monitoring-profile-binding-maps/<segment-monitoring-profile-binding-map-id>

List Segment QoS Profile Binding Maps


API will list all Segment QoS Profile Binding Maps in current segment id.
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-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.
PATCH /global-manager/api/v1/global-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.
PUT /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp

Read static ARP config


Read static ARP config
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segment-id>/static-arp

Get tier-1 segment port statistics information


Get tier-1 segment port statistics information.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/ports/<port-id>/statistics

Get segment state information


Get tier1 segment state information.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/state

Get segment statistics information


Get tier1 segment statistics information.
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/segments/<segments-id>/statistics

Get Tier1 state


Returns
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/state

List Tier-1 Static Routes


Paginated list of all Tier-1 Static Routes
GET /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes

Delete Tier-1 static routes


Delete Tier-1 static routes
DELETE /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>

Read Tier-1 static routes


Read Tier-1 static routes
GET /global-manager/api/v1/global-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 /global-manager/api/v1/global-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 /global-manager/api/v1/global-infra/tier-1s/<tier-1-id>/static-routes/<route-id>