NSX-T Data Center REST API

Associated URIs:

API Description API Path

Read All IPV6 DADProfiles


Returns all IPv6 DADProfiles.
GET /api/v1/ipv6/dad-profiles (Deprecated)

Create a new DADProfile


Adds a new DADProfile
POST /api/v1/ipv6/dad-profiles (Deprecated)

Delete DAD Profile


Delete DADProfile
DELETE /api/v1/ipv6/dad-profiles/{dad-profile-id} (Deprecated)

Read specified IPV6 DADProfile


Returns information about specified IPv6 DADProfile.
GET /api/v1/ipv6/dad-profiles/{dad-profile-id} (Deprecated)

Update DADProfile


Update DADProfile.
PUT /api/v1/ipv6/dad-profiles/{dad-profile-id} (Deprecated)

Read All IPV6 NDRA Profiles


Returns all IPv6 NDRA Profiles.
GET /api/v1/ipv6/nd-ra-profiles (Deprecated)

Create a new NDRA Profile


Adds a new NDRAProfile
POST /api/v1/ipv6/nd-ra-profiles (Deprecated)

Delete NDRA Profile


Delete NDRAProfile
DELETE /api/v1/ipv6/nd-ra-profiles/{nd-ra-profile-id} (Deprecated)

Read specified IPV6 NDRA Profile


Returns information about specified IPv6 NDRA Profile.
GET /api/v1/ipv6/nd-ra-profiles/{nd-ra-profile-id} (Deprecated)

Update NDRA Profile


Update NDRAProfile
PUT /api/v1/ipv6/nd-ra-profiles/{nd-ra-profile-id} (Deprecated)

Read the debug information for the logical router


API to download below information as text which will be used
for debugging and troubleshooting.
1) Logical router sub-components and ports.
2) Routing configuration as sent to central control plane.
3) TIER1 advertised network information.
GET /api/v1/logical-routers/{logical-router-id}/debug-info?format=text (Deprecated)

Read the Routing Configuration


Returns the routing configuration for a specified logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing (Deprecated)

Update the Routing Configuration


Modifies the routing configuration for a specified logical router.
PUT /api/v1/logical-routers/{logical-router-id}/routing (Deprecated)

Read the Advertisement Configuration on a Logical Router


Returns information about the routes to be advertised by the specified
TIER1 logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/advertisement (Deprecated)

Update the Advertisement Configuration on a Logical Router


Modifies the route advertisement configuration on the specified logical router.
PUT /api/v1/logical-routers/{logical-router-id}/routing/advertisement (Deprecated)

Read the Advertisement Rules on a Logical Router


Returns the advertisement rule list for the specified
TIER1 logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/advertisement/rules (Deprecated)

Update the Advertisement Rules on a Logical Router


Modifies the advertisement rules on the specified logical
router. The PUT request must include all the rules with the networks parameter. Modifiable
parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.
PUT /api/v1/logical-routers/{logical-router-id}/routing/advertisement/rules (Deprecated)

Read the BGP Configuration on a Logical Router


Returns information about the BGP configuration on a specified logical
router. Information includes whether or not the BGP configuration is
enabled, the AS number, and whether or not graceful
restart is enabled.
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp (Deprecated)

Update the BGP Configuration on a Logical Router


Modifies the BGP configuration on a specified TIER0 logical router.
Modifiable parameters include enabled, graceful_restart, as_number.
PUT /api/v1/logical-routers/{logical-router-id}/routing/bgp (Deprecated)

Paginated list of BGP community lists on a logical router


Paginated list of BGP Community Lists on a Logical Router
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp/community-lists (Deprecated)

Create a new BGP community list on a logical router


Add a new BGP Community List on a Logical Router
POST /api/v1/logical-routers/{logical-router-id}/routing/bgp/community-lists (Deprecated)

Delete a specific BGP community list from a logical router


Delete a specific BGP community list from a Logical Router
DELETE /api/v1/logical-routers/{logical-router-id}/routing/bgp/community-lists/{community-list-id} (Deprecated)

Read a specific BGP community list from a logical router


Read a specific BGP community list from a Logical Router
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp/community-lists/{community-list-id} (Deprecated)

Update a specific BGP community list from a logical router


Update a specific BGP community list from a Logical Router
PUT /api/v1/logical-routers/{logical-router-id}/routing/bgp/community-lists/{community-list-id} (Deprecated)

Update a specific BGP community list from a logical router


Update a specific BGP community list from a Logical Router
PUT /api/v1/logical-routers/{logical-router-id}/routing/bgp/communty-lists/{community-list-id} (Deprecated)

Paginated list of BGP Neighbors on a Logical Router


Paginated list of BGP Neighbors on a Logical Router
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors (Deprecated)

Add a new BGP Neighbor on a Logical Router


Add a new BGP Neighbor on a Logical Router
POST /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors (Deprecated)

Delete a specific BGP Neighbor on a Logical Router


Delete a specific BGP Neighbor on a Logical Router
DELETE /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id} (Deprecated)

Read a specific BGP Neighbor with password on a Logical Router


Read a specific BGP Neighbor details with password on a Logical Router
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id}?action=show-sensitive-data (Deprecated)

Read a specific BGP Neighbor on a Logical Router


Read a specific BGP Neighbor on a Logical Router
GET /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id} (Deprecated)

Unset/Delete password property on specific BGP Neighbor on Logical Router


Unset/Delete the password property on the specific BGP Neighbor.
No other property of the BgpNeighbor can be updated using this API
POST /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id} (Deprecated)

Update a specific BGP Neighbor on a Logical Router


Update a specific BGP Neighbor on a Logical Router
PUT /api/v1/logical-routers/{logical-router-id}/routing/bgp/neighbors/{id} (Deprecated)

Paginated List of IPPrefixLists


Paginated List of IPPrefixLists 		GET /api/v1/logical-routers/{logical-router-id}/routing/ip-prefix-lists (Deprecated)

Add IPPrefixList on a Logical Router


Adds a new IPPrefixList on a Logical Router
POST /api/v1/logical-routers/{logical-router-id}/routing/ip-prefix-lists (Deprecated)

Delete a specific IPPrefixList on a Logical Router


Deletes a specific IPPrefixList on the specified logical router.
DELETE /api/v1/logical-routers/{logical-router-id}/routing/ip-prefix-lists/{id} (Deprecated)

Get a specific IPPrefixList on a Logical Router


Read a specific IPPrefixList on the specified logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/ip-prefix-lists/{id} (Deprecated)

Update a specific IPPrefixList on a Logical Router


Update a specific IPPrefixList on the specified logical router.
PUT /api/v1/logical-routers/{logical-router-id}/routing/ip-prefix-lists/{id} (Deprecated)

Read the Redistribution Configuration on a Logical Router


Returns information about configured route redistribution for the specified
logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/redistribution (Deprecated)

Update the Redistribution Configuration on a Logical Router


Modifies existing route redistribution rules for the specified TIER0 logical
router.
PUT /api/v1/logical-routers/{logical-router-id}/routing/redistribution (Deprecated)

Read All the Redistribution Rules on a Logical Router


Returns all the route redistribution rules for the specified
logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/redistribution/rules (Deprecated)

Update All the Redistribution Rules on a Logical Router


Modifies all route redistribution rules for the specified TIER0 logical
router. Set the rules list to empty to delete/clear all rules.
PUT /api/v1/logical-routers/{logical-router-id}/routing/redistribution/rules (Deprecated)

Paginated List of RouteMaps


Paginated List of RouteMaps 		GET /api/v1/logical-routers/{logical-router-id}/routing/route-maps (Deprecated)

Add RouteMap on a Logical Router


Adds a new RouteMap on a Logical Router
POST /api/v1/logical-routers/{logical-router-id}/routing/route-maps (Deprecated)

Delete a specific RouteMap on a Logical Router


Deletes a specific RouteMap on the specified logical router.
DELETE /api/v1/logical-routers/{logical-router-id}/routing/route-maps/{id} (Deprecated)

Get a specific RouteMap on a Logical Router


Read a specific RouteMap on the specified logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/route-maps/{id} (Deprecated)

Update a specific RouteMap on a Logical Router


Update a specific RouteMap on the specified logical router.
PUT /api/v1/logical-routers/{logical-router-id}/routing/route-maps/{id} (Deprecated)

Paginated List of Static Routes


Returns information about configured static routes, including the
network address and next hops for each static route.
GET /api/v1/logical-routers/{logical-router-id}/routing/static-routes (Deprecated)

Add Static Routes on a Logical Router


Adds a new static route on a Logical Router
POST /api/v1/logical-routers/{logical-router-id}/routing/static-routes (Deprecated)

Delete a specific Static Route on a Logical Router


Deletes a specific static route on the specified logical router.
DELETE /api/v1/logical-routers/{logical-router-id}/routing/static-routes/{id} (Deprecated)

Get a specific Static Route on a Logical Router


Read a specific static routes on the specified logical router.
GET /api/v1/logical-routers/{logical-router-id}/routing/static-routes/{id} (Deprecated)

Update a specific Static Route Rule on a Logical Router


Update a specific static route on the specified logical router.
PUT /api/v1/logical-routers/{logical-router-id}/routing/static-routes/{id} (Deprecated)