NSX-T Data Center REST API

Associated URIs:

API Description API Path

List route controllers


List route controllers
GET /policy/api/v1/infra/route-controllers

Get BGP neighbor advertised routes


Returns routes advertised by BGP neighbor from all virtual network appliance nodes on which
this neighbor is currently enabled in CSV format.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/{neighbor-id}/advertised-routes

Get BGP neighbor advertised routes in CSV format


Returns routes advertised by BGP neighbor from all virtual network appliance nodes on which
this neighbor is currently enabled in CSV format.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/{neighbor-id}/advertised-routes/download

Get routes learned by BGP neighbor


Returns routes learned by BGP neighbor from all virtual network appliance nodes on which
this neighbor is currently enabled.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/{neighbor-id}/routes

Get routes learned by BGP neighbor in CSV format


Returns routes learned by BGP neighbor from all virtual network appliance nodes on which
this neighbor is currently enabled.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/{neighbor-id}/routes/download

Get BGP neighbor status for the route controller


Returns the status of all the BGP neighbors for the given route controller.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/bgp/neighbors/status

Get forwarding table from route controller


Get forwarding table from route controller
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/forwarding-table

Get forwarding table from route controller in CSV format.


Get forwarding table from route controller in CSV format.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/forwarding-table/download

Get policy route controller interface statistics for given interface-id


Get policy route controller interface statistics for given interface-id
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/interfaces/{interface-id}/statistics

Get policy route controller interface statistics summary for given interface-id


Get policy route controller interface statistics summary for given interface-id
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/interfaces/{interface-id}/statistics/summary

Get routing table from route controller


Get routing table from route controller
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/routing-table

Get routing table from route controller in CSV format.


Get routing table from route controller in CSV format.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/routing-table/download

Get the route controller state


Get the route controller's runtime state.
GET /policy/api/v1/infra/route-controllers/{route-controller-id}/state

Delete a route controller


Delete a route controller
DELETE /policy/api/v1/infra/route-controllers/{router-controller-id}

Read a route controller


Read a route controller.
GET /policy/api/v1/infra/route-controllers/{router-controller-id}

Patch a route controller


If a route controller is not already present, create a new route controller.
If it already exists, update the route controller.
PATCH /policy/api/v1/infra/route-controllers/{router-controller-id}

Create or update route controller


If a route controller is not already present, create a new route controller.
If it already exists, update the route controller. This operation will fully replace the object.
PUT /policy/api/v1/infra/route-controllers/{router-controller-id}

Delete a BGP routing config


Delete a BGP routing config
DELETE /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp

Read a BGP routing config


Read a BGP routing config.
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp

Patch a BGP routing config


If a BGP routing config is not already present, create a new BGP routing config.
If it already exists, update the BGP routing config.
PATCH /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp

Create or update route controller BGP routing config


If a BGP routing config is not already present, create a new BGP routing config.
If it already exists, update the BGP routing config. This operation will fully replace the object.
PUT /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp

List BGP neighbor configs


List BGP neighbor configs
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/neighbors

Delete a BGP neighbor config


Delete a BGP neighbor config
DELETE /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/neighbors/{neighbor-id}

Read a BGP neighbor config


Read a BGP neighbor config.
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/neighbors/{neighbor-id}

Patch a BGP neighbor config


If a BGP neighbor config is not already present, create a new BGP neighbor config.
If it already exists, update the BGP neighbor config.
PATCH /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/neighbors/{neighbor-id}

Create or update BGP neighbor config


If a BGP neighbor config is not already present, create a new BGP neighbor config.
If it already exists, update the BGP neighbor config. This operation will fully replace the object.
PUT /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/neighbors/{neighbor-id}

Delete BGP troubleshoot config


Delete BGP troubleshoot config
DELETE /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/troubleshoot

Read BGP troubleshoot config


Read BGP troubleshoot config
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/troubleshoot

Create or update a BGP troubleshoot config


If BGP troubleshoot config is not present in BGP configuration, create a new BGP
troubleshoot config with default value. If it already exists, update the BGP
troubleshoot config with this object.
PATCH /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/troubleshoot

Create or update a BGP troubleshoot config


If BGP troubleshoot config is not present in BGP configuration, create a new BGP
troubleshoot config with default value. If it already exists, update the BGP
troubleshoot config with this object.
PUT /policy/api/v1/infra/route-controllers/{router-controller-id}/bgp/troubleshoot

List route controller interfaces


List route controller interfaces
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/interfaces

Delete a route controller interface


Delete a route controller interface
DELETE /policy/api/v1/infra/route-controllers/{router-controller-id}/interfaces/{interface-id}

Read a route controller interface


Read a route controller interface.
GET /policy/api/v1/infra/route-controllers/{router-controller-id}/interfaces/{interface-id}

Patch a route controller interface


If a route controller interface is not already present, create a new route controller interface.
If it already exists, update the route controller interface.
PATCH /policy/api/v1/infra/route-controllers/{router-controller-id}/interfaces/{interface-id}

Create or update route controller interface


If a route controller interface is not already present, create a new route controller interface.
If it already exists, update the route controller interface. This operation will fully replace the object.
PUT /policy/api/v1/infra/route-controllers/{router-controller-id}/interfaces/{interface-id}

Get Network Span for the transport Zone


gives a list of network span for the TZ
GET /policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcementpoint-id}/transport-zones/{transport-zone-id}/spans