API Description | API Path |
---|---|
List BGP community listsPaginated 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 listDelete a BGP community list |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/community-lists/{community-list-id}
|
Read a BGP community listRead 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 listIf 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 listIf 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}
|
Get forwarding table from tier-0Get 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 formatGet 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 configurationsList all inter-vrf routing configurations. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/inter-vrf-routing
|
Delete inter-vrf routing configDelete 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 configRead 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 configCreate 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 configCreate 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 networksReturns 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 formatList 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
|
Delete overridden BGP routing configDeletes 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 configRead 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 configIf 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 configIf 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 configurationsPaginated 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 configDelete 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 configRead 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 configIf 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 configIf 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 routesReturns 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 formatReturns 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 formatReturns 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 neighborReturns 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 Tier0Returns 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 |
Read OSPF routing configRead 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 configIf 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 configIf 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 configurationsList all OSPF area configurations. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/areas
|
Delete OSPF Area configDelete 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 configRead 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 configIf 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 configIf 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 informationGet 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 formatGet 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 informationGet OSPF neighbor information. |
GET /policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/ospf/neighbors
|
Get OSPF route informationGet 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 formatGet 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
|
Get total number of IPv4 or IPv6 routes on a Tier0Get 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 listsPaginated 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 listDelete a prefix list |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/prefix-lists/{prefix-list-id}
|
Read a prefix listRead 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 listIf 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 listIf 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 mapsPaginated 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 mapDelete a route map |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/route-maps/{route-map-id}
|
Read a route mapRead 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 mapIf 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 mapIf 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-0Get 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 formatGet 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 stateReturns |
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 RoutesPaginated 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 routesDelete Tier-0 static routes |
DELETE /policy/api/v1/infra/tier-0s/{tier-0-id}/static-routes/{route-id}
|
Read Tier-0 static routesRead 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 routesIf 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 routesIf 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 StaticRouteBfdPeersPaginated 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 StaticRouteBfdPeerRead 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 StaticRouteBfdPeerIf 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 StaticRouteBfdPeerIf 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}
|