NSX Autonomous Edge REST API

Associated URIs:

API Description API Path

Get Edge maintenance mode


GET /node/maintenance-mode

Set Edge maintenance mode


PUT /node/maintenance-mode

Read NSX Edge Docker service properties


Read the Docker service process properties from Edge.
GET /node/services/docker

Read NSX Edge Docker service status


Checks the status of dockerd process on the Edge.
If dockerd process is running, returns "running",
returns "stopped" otherwise.
GET /node/services/docker/status

Read NSX Edge Ipsec VPN service properties


Read the IPsec VPN service process properties from Edge.
GET /node/services/ipsecvpn

Update NSX Edge Ipsec VPN service properties


PUT /node/services/ipsecvpn

Read NSX Edge Ipsec VPN service status


Checks the status of iked process on the Edge.
If iked process is running, returns "running",
returns "stopped" otherwise.
GET /node/services/ipsecvpn/status

Read NSX Edge NSXA service properties


GET /node/services/local-controller

Restart, start or stop the NSX EdgeNSXA service


POST /node/services/local-controller?action=restart
POST /node/services/local-controller?action=start
POST /node/services/local-controller?action=stop

Read NSX EdgeNSXA service status


GET /node/services/local-controller/status

Read NSX Autonomous Edge Replica Agent client status from the seconday node


GET /node/services/replica-agent/client/status

Read NSX EdgeMSR service properties


GET /node/services/router

Read NSX EdgeMSRConfig service properties


GET /node/services/router-config

Read NSX EdgeMSRConfig service status


GET /node/services/router-config/status

Read NSX EdgeMSR service status


GET /node/services/router/status