| API Description |
API Path |
Delete evpn tunnel endpoint configuration
Delete evpn tunnel endpoint configuration.
|
DELETE /policy/api/v1/infra/evpn-tenant-configs/{config-id}
|
Delete Pim Profile
Delete Pim Profile.
|
DELETE /policy/api/v1/infra/pim-profiles/{pim-profile-id}
|
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 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
|
List Tier-0s
Paginated list of all Tier-0s
|
GET /policy/api/v1/infra/tier-0s
GET /policy/api/v1/global-infra/tier-0s
|
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
|
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
|