NSX Autonomous Edge REST API

Associated URIs:

API Description API Path

Read network configuration properties


GET /node/network

List the Node's Network Interfaces


Returns the number of interfaces on the node appliance and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).
GET /node/network/interfaces

Read the Node's Network Interface


Returns detailed information about the specified interface. Interface
information includes MTU, broadcast and host IP addresses, link and admin
status, MAC address, network mask, and the IP configuration method.
GET /node/network/interfaces/{interface-id}

Update the Node's Network Interface


Updates the specified interface properties, which includes
configuring IPv6 address when NSX appliance has only IPv4 management address.
But once configured you cannot modify following interface properties -
ip_configuration, ip_addresses,
ip6_addresses or plane.
NSX Manager must have a static IPv4 or IPv6 address.
You must use NSX CLI to configure the manager or edge appliance.
Note: NSX appliance reboot is required after adding IPv6 address.
PUT /node/network/interfaces/{interface-id}

Read the Node's Network Interface Statistics


On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.
GET /node/network/interfaces/{interface-id}/stats