NSX-T Data Center REST API

List Logical Routers (Deprecated)

Returns information about all logical routers, including the UUID, internal
and external transit network addresses, and the router type (TIER0 or
TIER1). You can get information for only TIER0 routers or only the TIER1
routers by including the router_type query parameter.
Deprecated:
Please use below policy apis instead of this API.
GET /infra/tier-0s/
GET /infra/tier-1s/

Request:

Method:
GET
URI Path(s):
/api/v1/logical-routers
Request Headers:
n/a
Query Parameters:
LogicalRouterListParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/logical-routers?router_type=TIER0

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
LogicalRouterListResult+

Example Response:

{ "cursor": "00364c87219e-7361-4fa4-9b4e-c612ed56f1fdtier-0", "result_count": 1, "results": [ { "resource_type": "LogicalRouter", "description": "", "id": "4c87219e-7361-4fa4-9b4e-c612ed56f1fd", "display_name": "tier-0", "tags": [], "edge_cluster_id": "a9dc562c-effd-4225-883d-3f7d2c887c6b", "advanced_config": { "external_transit_networks": [ "100.64.0.0/10" ], "internal_transit_network": "169.254.0.0/28" }, "allocation_profile": { "enable_standby_relocation": false } "router_type": "TIER0", "high_availability_mode": "ACTIVE_ACTIVE", "_last_modified_time": 1457505773124, "_create_time": 1457505741221, "_last_modified_user": "admin", "_system_owned": false, "_create_user": "admin", "_revision": 1 } ] }

Required Permissions:

read

Feature:

routing_routers

Additional Errors: