NSX Autonomous Edge REST API

List Ports

Returns information about all logical ports.

Request:

Method:
GET
URI Path(s):
/ports
Request Headers:
n/a
Query Parameters:
LogicalPortListParameters+
Request Body:
n/a

Example Request:

GET https://<ip>/api/v1/ports

Successful Response:

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

Example Response:

{ "_schema": "LogicalPortListResult", "_self": { "href": "/api/v1/ports", "rel": "self" }, "result_count": 3, "results": [ { "display_name": "80c7dee7-6bb0-4d3f-a813-265f29f565e6", "id": "80c7dee7-6bb0-4d3f-a813-265f29f565e6", "resource_type": "LogicalRouterIPTunnelPort", "subnets": [ { "ip_addresses": [ "192.168.50.1" ], "prefix_length": 31 } ] }, { "description": "Extend vlan segment", "display_name": "l2-extn-port-200", "exit_interface": "eth3", "l2_extensions": [ { "l2vpn_session_id": "d3750dd2-1e91-43e1-9b3c-f2de0052b6f1", "l2vpn_session_name": "l2vpn session", "tunnel_id": 200, "l2_rewrite" : true, "remote_gw_mac" : "02:50:56:56:44:52", "stitch_mac" : "02:50:56:48:43:58", "arp_resolver" : true, "gateway_ip" : "172.16.128.126", "arp_resolver_mac" : "00:50:56:96:58:75", "mon" : true, "local_gw_mac": "02:50:56:56:44:52" "filter_spcl_garp" : true } ], "mac_address": "00:50:56:96:58:75", "mtu": 1500, "resource_type": "LogicalRouterPort", "urpf_mode": "STRICT", "vlan_id": 200, }, { "display_name": "uplink", "exit_interface": "eth1", "id": "2fc78df9-cd37-4ee2-92e5-699e505b34e1", "mac_address": "00:50:56:84:b1:af", "mtu": 1500, "resource_type": "LogicalRouterPort", "subnets": [ { "ip_addresses": [ "30.30.30.10" ], "prefix_length": 24 } ], "urpf_mode": "STRICT", "vlan_id": 100 } ] }

Required Permissions:

read

Feature:

routing_routers

Additional Errors: