NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
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}
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
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
List advertised networks Returns information about all networks which advertised to TIER0 LR.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/inter-vrf-routing/{inter-vrf-routing-id}/advertised-networks
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=<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 /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp/neighbors/status
Get total number of IPv4 or IPv6 routes on a Tier0 Get total number of IPv4 or IPv6 routes on a Tier0	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/number-of-routes
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 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 /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. 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 /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}