NSX Autonomous Edge REST API
All Methods
| API Description | API Path |
|---|---|
| Logical Routing And Services Configuration > High Availability Read all peers in the cluster |
GET /high-availability
|
| Logical Routing And Services Configuration > High Availability API to call when the primary API node edge is lost, crashed or dead |
POST /high-availability?action=dissolve_and_make_primary
|
| Logical Routing And Services Configuration > High Availability Delete a specific HighAvailabilityPeer |
DELETE /high-availability/nodes/{node-id}
|
| Logical Routing And Services Configuration > High Availability Read node status |
GET /high-availability/nodes/{node-id}/status
|
| Logical Routing And Services Configuration > Logical Ports List Ports |
GET /ports
|
| Logical Routing And Services Configuration > Logical Ports Create a Logical Port |
POST /ports
|
| Logical Routing And Services Configuration > Logical Ports Get the statistics of a specified LogicalRouterPort |
GET /ports/{logical-router-port-id}/statistics
|
| Logical Routing And Services Configuration > Logical Ports Delete a Logical Port |
DELETE /ports/{port-id}
|
| Logical Routing And Services Configuration > Logical Ports Read Logical Port |
GET /ports/{port-id}
|
| Logical Routing And Services Configuration > Logical Ports Update a Logical Port |
PUT /ports/{port-id}
|
| Logical Routing And Services Configuration > Routing Get forwarding table on the logical router |
GET /routing/forwarding-table
|
| Logical Routing And Services Configuration > Routing Paginated List of Static Routes |
GET /routing/static-routes
|
| Logical Routing And Services Configuration > Routing Add Static Routes on a Logical Router |
POST /routing/static-routes
|
| Logical Routing And Services Configuration > Routing Delete a specific Static Route on a Logical Router |
DELETE /routing/static-routes/{static-route-id}
|
| Logical Routing And Services Configuration > Routing Get a specific Static Route on a Logical Router |
GET /routing/static-routes/{static-route-id}
|
| Logical Routing And Services Configuration > Routing Update a specific Static Route Rule on a Logical Router |
PUT /routing/static-routes/{static-route-id}
|
| Logical Routing And Services Configuration > VPN > L2VPN Get all L2VPN sessions |
GET /vpn/l2vpn/sessions
|
| Logical Routing And Services Configuration > VPN > L2VPN Create an L2VPN session from Peer Code |
POST /vpn/l2vpn/sessions?action=create_with_peer_code
|
| Logical Routing And Services Configuration > VPN > L2VPN Delete a L2VPN session |
DELETE /vpn/l2vpn/sessions/{l2vpn-session-id}
|
| Logical Routing And Services Configuration > VPN > L2VPN Get a L2VPN session |
GET /vpn/l2vpn/sessions/{l2vpn-session-id}
|
| Logical Routing And Services Configuration > VPN > L2VPN Update an L2VPN session with a new peer code |
PUT /vpn/l2vpn/sessions/{l2vpn-session-id}?action=update_with_peer_code
|
| Logical Routing And Services Configuration > VPN > L2VPN Get L2VPN session statistics |
GET /vpn/l2vpn/sessions/{l2vpn-session-id}/statistics
|
| System Administration > Configuration > Fabric > Nodes > DNS Read the Node's Name Servers |
GET /node/network/name-servers
|
| System Administration > Configuration > Fabric > Nodes > DNS Update the Node's Name Servers |
PUT /node/network/name-servers
|
| System Administration > Configuration > Fabric > Nodes > DNS Read the Node's Search Domains |
GET /node/network/search-domains
|
| System Administration > Configuration > Fabric > Nodes > DNS Update the Node's Search Domains |
PUT /node/network/search-domains
|
| System Administration > Configuration > Fabric > Nodes > File Store Delete directory in remote file server |
DELETE /node/file-store?action=delete_remote_directory
|
| System Administration > Configuration > Fabric > Nodes > File Store List node files |
GET /node/file-store
|
| System Administration > Configuration > Fabric > Nodes > File Store Retrieve ssh fingerprint for given remote server |
POST /node/file-store?action=retrieve_ssh_fingerprint
|
| System Administration > Configuration > Fabric > Nodes > File Store Create directory in remote file server |
POST /node/file-store?action=create_remote_directory
|
| System Administration > Configuration > Fabric > Nodes > File Store Delete file |
DELETE /node/file-store/{file-name}
|
| System Administration > Configuration > Fabric > Nodes > File Store Read file properties |
GET /node/file-store/{file-name}
|
| System Administration > Configuration > Fabric > Nodes > File Store Upload a file to the file store |
POST /node/file-store/{file-name}
|
| System Administration > Configuration > Fabric > Nodes > File Store Copy file in the file store to a remote file store |
POST /node/file-store/{file-name}?action=copy_to_remote_file
|
| System Administration > Configuration > Fabric > Nodes > File Store Copy a remote file to the file store |
POST /node/file-store/{file-name}?action=copy_from_remote_file
|
| System Administration > Configuration > Fabric > Nodes > File Store Read file contents |
GET /node/file-store/{file-name}/data
|
| System Administration > Configuration > Fabric > Nodes > File Store Replace file contents |
PUT /node/file-store/{file-name}/data
|
| System Administration > Configuration > Fabric > Nodes > File Store Read file thumbprint |
GET /node/file-store/{file-name}/thumbprint
|
| System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control Gets the enable status for Mandatory Access Control |
GET /node/hardening-policy/mandatory-access-control
|
| System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control Enable or disable Mandatory Access Control |
PUT /node/hardening-policy/mandatory-access-control
|
| System Administration > Configuration > Fabric > Nodes > Hardening > Mandatory Access Control Get the report for Mandatory Access Control |
GET /node/hardening-policy/mandatory-access-control/report
|
| System Administration > Configuration > Fabric > Nodes > Logs List available node logs |
GET /node/logs
|
| System Administration > Configuration > Fabric > Nodes > Logs Read node log properties |
GET /node/logs/{log-name}
|
| System Administration > Configuration > Fabric > Nodes > Logs Read node log contents |
GET /node/logs/{log-name}/data
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Certificates Read api certificate properties |
GET /node/api-certificate
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Certificates Update api certificate properties |
POST /node/api-certificate
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Read NSX EdgeDatapath service properties |
GET /node/services/dataplane
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Restart, start or stop the NSX EdgeDatapath service |
POST /node/services/dataplane?action=restart
POST /node/services/dataplane?action=start POST /node/services/dataplane?action=stop |
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge Datapath service properties |
PUT /node/services/dataplane
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge dataplane cpu stats |
GET /node/services/dataplane/cpu-stats
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane control packets prioritization setting |
PUT /node/services/dataplane/ctrl-prio
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge dataplane flow cache setting |
GET /node/services/dataplane/flow-cache
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane flow cache setting |
PUT /node/services/dataplane/flow-cache
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Return top 10 flows information |
GET /node/services/dataplane/flow-mon
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Start NSX Edge dataplane flow monitor |
PUT /node/services/dataplane/flow-mon
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane interrupt mode setting |
PUT /node/services/dataplane/intr-mode
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge dataplane l2vpn pmtu message generation setting |
GET /node/services/dataplane/l2vpn-pmtu
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane l2vpn pmtu message generation setting |
PUT /node/services/dataplane/l2vpn-pmtu
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Depreciated. Please use /node/services/dataplane/pmtu-learning |
GET /node/services/dataplane/l3vpn-pmtu
(Deprecated)
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Depreciated. Please use /node/services/dataplane/pmtu-learning |
PUT /node/services/dataplane/l3vpn-pmtu
(Deprecated)
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge dataplane pmtu learning setting |
GET /node/services/dataplane/pmtu-learning
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane pmtu learning setting |
PUT /node/services/dataplane/pmtu-learning
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Update NSX Edge dataplane QAT feature enabled status |
PUT /node/services/dataplane/qat-enable
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge dataplane QAT setting |
GET /node/services/dataplane/qat-status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Get NSX Edge rx and tx queue number per port per core |
GET /node/services/dataplane/queue-num-per-port-per-core
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Set NSX Edge rx and tx queue number per port per core |
PUT /node/services/dataplane/queue-num-per-port-per-core
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Return rx/tx ring size information |
GET /node/services/dataplane/ring-size
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Set NSX Edge rx ring size for physical ports |
PUT /node/services/dataplane/rx-ring-size
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Read NSX EdgeDatapath service status |
GET /node/services/dataplane/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Set NSX Edge tx ring size for physical ports |
PUT /node/services/dataplane/tx-ring-size
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Dataplane Check UPT mode enabled status of NSX Edge dataplane |
GET /node/services/dataplane/upt-mode
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis Read edge config diagnosis |
GET /node/diagnosis
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis Read edge diagnosis inconsistency |
GET /node/diagnosis/inconsistency
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis Logical-router diagnosis |
GET /node/logical-routers/{logical-router-id}/diagnosis
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Diagnosis Logical-routers diagnosis |
GET /node/logical-routers/diagnosis
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb Read NSX Nestdb service properties |
GET /node/services/nestdb
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb Restart, start or stop the NSX Nestdb service |
POST /node/services/nestdb?action=restart
POST /node/services/nestdb?action=start POST /node/services/nestdb?action=stop |
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Nestdb Read NSX Nestdb service status |
GET /node/services/nestdb/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Replication Agent Read NSX Edge Replica Agent service properties |
GET /node/services/replica-agent
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Replication Agent Restart, start or stop the NSX Edge Replica Agent service |
POST /node/services/replica-agent?action=restart
POST /node/services/replica-agent?action=start POST /node/services/replica-agent?action=stop |
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Replication Agent Read NSX Edge Replica Agent service status |
GET /node/services/replica-agent/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Docker Read NSX Edge Docker service properties |
GET /node/services/docker
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Docker Read NSX Edge Docker service status |
GET /node/services/docker/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Ipsecvpn Service Update NSX Edge Ipsec VPN service properties |
PUT /node/services/ipsecvpn
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Local-Controller Read NSX Edge NSXA service properties |
GET /node/services/local-controller
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > 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 |
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Local-Controller Read NSX EdgeNSXA service status |
GET /node/services/local-controller/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Maintenance Mode Get Edge maintenance mode |
GET /node/maintenance-mode
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Maintenance Mode Set Edge maintenance mode |
PUT /node/maintenance-mode
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Replication Agent Read NSX Autonomous Edge Replica Agent client status from the seconday node |
GET /node/services/replica-agent/client/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing Read NSX EdgeMSR service properties |
GET /node/services/router
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing Read NSX EdgeMSRConfig service properties |
GET /node/services/router-config
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing Read NSX EdgeMSRConfig service status |
GET /node/services/router-config/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > Routing Read NSX EdgeMSR service status |
GET /node/services/router/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > VPN Read NSX Edge Ipsec VPN service properties |
GET /node/services/ipsecvpn
|
| System Administration > Configuration > Fabric > Nodes > NSX Edge > Services > VPN Read NSX Edge Ipsec VPN service status |
GET /node/services/ipsecvpn/status
|
| System Administration > Configuration > Fabric > Nodes > NSX Manager > Services > Local-Controller Service Update NSX Edge NSXA service properties |
PUT /node/services/local-controller
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces Read network configuration properties |
GET /node/network
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces List the Node's Network Interfaces |
GET /node/network/interfaces
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces Read the Node's Network Interface |
GET /node/network/interfaces/{interface-id}
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces Update the Node's Network Interface |
PUT /node/network/interfaces/{interface-id}
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces Read the Node's Network Interface Statistics |
GET /node/network/interfaces/{interface-id}/stats
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing List node network routes |
GET /node/network/routes
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing Create node network route |
POST /node/network/routes
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing Delete node network route |
DELETE /node/network/routes/{route-id}
|
| System Administration > Configuration > Fabric > Nodes > Network Interfaces > Routing Read node network route |
GET /node/network/routes/{route-id}
|
| System Administration > Configuration > Fabric > Nodes > Services List node services |
GET /node/services
|
| System Administration > Configuration > Fabric > Nodes > Services > Log Insight Read liagent service properties |
GET /node/services/liagent
|
| System Administration > Configuration > Fabric > Nodes > Services > Log Insight Restart, start or stop the liagent service |
POST /node/services/liagent?action=restart
POST /node/services/liagent?action=start POST /node/services/liagent?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > Log Insight Read liagent service status |
GET /node/services/liagent/status
|
| System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client Read NSX Platform Client service properties |
GET /node/services/nsx-platform-client
|
| System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client Restart, start or stop the NSX Platform Client service |
POST /node/services/nsx-platform-client?action=restart
POST /node/services/nsx-platform-client?action=start POST /node/services/nsx-platform-client?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > NSX Platform Client Read NSX Platform Client service status |
GET /node/services/nsx-platform-client/status
|
| System Administration > Configuration > Fabric > Nodes > Services > NTP Read NTP service properties |
GET /node/services/ntp
|
| System Administration > Configuration > Fabric > Nodes > Services > NTP Restart, start or stop the NTP service |
POST /node/services/ntp?action=restart
POST /node/services/ntp?action=start POST /node/services/ntp?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > NTP Update NTP service properties |
PUT /node/services/ntp
|
| System Administration > Configuration > Fabric > Nodes > Services > NTP Read NTP service status |
GET /node/services/ntp/status
|
| System Administration > Configuration > Fabric > Nodes > Services > Node Management Read appliance management service properties |
GET /node/services/node-mgmt
|
| System Administration > Configuration > Fabric > Nodes > Services > Node Management Restart the node management service |
POST /node/services/node-mgmt?action=restart
|
| System Administration > Configuration > Fabric > Nodes > Services > Node Management Retrieve Node Management loglevel |
GET /node/services/node-mgmt/loglevel
|
| System Administration > Configuration > Fabric > Nodes > Services > Node Management Set Node Management loglevel |
PUT /node/services/node-mgmt/loglevel
|
| System Administration > Configuration > Fabric > Nodes > Services > Node Management Read appliance management service status |
GET /node/services/node-mgmt/status
|
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Read SNMP service properties |
GET /node/services/snmp
|
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Restart, start or stop the SNMP service |
POST /node/services/snmp?action=restart
POST /node/services/snmp?action=start POST /node/services/snmp?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Update SNMP service properties |
PUT /node/services/snmp
|
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Read SNMP service status |
GET /node/services/snmp/status
|
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Read SNMP V3 Engine ID |
GET /node/services/snmp/v3-engine-id
|
| System Administration > Configuration > Fabric > Nodes > Services > SNMP Update SNMP V3 Engine ID |
PUT /node/services/snmp/v3-engine-id
|
| System Administration > Configuration > Fabric > Nodes > Services > SSH Read ssh service properties |
GET /node/services/ssh
|
| System Administration > Configuration > Fabric > Nodes > Services > SSH Remove a host's fingerprint from known hosts file |
POST /node/services/ssh?action=remove_host_fingerprint
|
| System Administration > Configuration > Fabric > Nodes > Services > SSH Restart, start or stop the ssh service |
POST /node/services/ssh?action=start
POST /node/services/ssh?action=stop POST /node/services/ssh?action=restart |
| System Administration > Configuration > Fabric > Nodes > Services > SSH Update ssh service properties |
PUT /node/services/ssh
|
| System Administration > Configuration > Fabric > Nodes > Services > SSH Restart, start or stop the ssh service |
POST /node/services/ssh/notify_mpa?action=start
POST /node/services/ssh/notify_mpa?action=stop POST /node/services/ssh/notify_mpa?action=restart |
| System Administration > Configuration > Fabric > Nodes > Services > SSH Read ssh service status |
GET /node/services/ssh/status
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Read syslog service properties |
GET /node/services/syslog
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Restart, start or stop the syslog service |
POST /node/services/syslog?action=restart
POST /node/services/syslog?action=start POST /node/services/syslog?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Delete all node syslog exporters |
DELETE /node/services/syslog/exporters
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog List node syslog exporters |
GET /node/services/syslog/exporters
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Verify node syslog exporter |
POST /node/services/syslog/exporters?action=verify
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Add node syslog exporter |
POST /node/services/syslog/exporters
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Delete node syslog exporter |
DELETE /node/services/syslog/exporters/{exporter-name}
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Read node syslog exporter |
GET /node/services/syslog/exporters/{exporter-name}
|
| System Administration > Configuration > Fabric > Nodes > Services > Syslog Read syslog service status |
GET /node/services/syslog/status
|
| System Administration > Configuration > Fabric > Nodes > Services > Tasks List appliance management tasks |
GET /node/tasks
|
| System Administration > Configuration > Fabric > Nodes > Services > Tasks Delete task |
DELETE /node/tasks/{task-id}
|
| System Administration > Configuration > Fabric > Nodes > Services > Tasks Read task properties |
GET /node/tasks/{task-id}
|
| System Administration > Configuration > Fabric > Nodes > Services > Tasks Cancel specified task |
POST /node/tasks/{task-id}?action=cancel
|
| System Administration > Configuration > Fabric > Nodes > Services > Tasks Read asynchronous task response |
GET /node/tasks/{task-id}/response
|
| System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent Read NSX upgrade Agent service properties |
GET /node/services/nsx-upgrade-agent
|
| System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent Restart, start or stop the NSX upgrade agent service |
POST /node/services/nsx-upgrade-agent?action=restart
POST /node/services/nsx-upgrade-agent?action=start POST /node/services/nsx-upgrade-agent?action=stop |
| System Administration > Configuration > Fabric > Nodes > Services > Upgrade Agent Read Nsx upgrade agent service status |
GET /node/services/nsx-upgrade-agent/status
|
| System Administration > Configuration > Fabric > Nodes > Settings Read node properties |
GET /node
|
| System Administration > Configuration > Fabric > Nodes > Settings Set the node system time |
POST /node?action=set_system_time
|
| System Administration > Configuration > Fabric > Nodes > Settings Restart or shutdown node |
POST /node?action=restart
POST /node?action=shutdown |
| System Administration > Configuration > Fabric > Nodes > Settings Update node properties |
PUT /node
|
| System Administration > Configuration > Fabric > Nodes > Settings Read node message of the day |
GET /node/motd
|
| System Administration > Configuration > Fabric > Nodes > Settings List node processes |
GET /node/processes
|
| System Administration > Configuration > Fabric > Nodes > Settings Read node process |
GET /node/processes/{process-id}
|
| System Administration > Configuration > Fabric > Nodes > Settings Read node status |
GET /node/status
|
| System Administration > Configuration > Fabric > Nodes > Settings Update node status |
POST /node/status?action=clear_bootup_error
|
| System Administration > Configuration > Fabric > Nodes > Settings Read node version |
GET /node/version
|
| System Administration > Configuration > Fabric > Nodes > Support-Bundle Read node support bundle |
GET /node/support-bundle
|
| System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy Read node authentication policy and password complexity configuration |
GET /node/aaa/auth-policy
|
| System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy Resets node authentication policy and password complexity configuration |
POST /node/aaa/auth-policy?action=reset-all
POST /node/aaa/auth-policy?action=reset-auth-policies POST /node/aaa/auth-policy?action=reset-pwd-complexity |
| System Administration > Configuration > Fabric > Nodes > User Management > Authentication Policy Update node authentication policy and password complexity configuration |
PUT /node/aaa/auth-policy
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users List node users. This is a hidden API used for NSX+ onboarding |
GET /node/nsxplus-onboarding/node/users
GET /node/nsxplus-onboarding/node/users?internal=true |
| System Administration > Configuration > Fabric > Nodes > User Management > Users List node users |
GET /node/users
GET /node/users?internal=true |
| System Administration > Configuration > Fabric > Nodes > User Management > Users Delete node user |
DELETE /node/users/{userid}
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users Read node user |
GET /node/users/{userid}
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users Update node user |
PUT /node/users/{userid}
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users List SSH keys from authorized_keys file for node user |
GET /node/users/{userid}/ssh-keys
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users Add SSH public key to authorized_keys file for node user |
POST /node/users/{userid}/ssh-keys?action=add_ssh_key
|
| System Administration > Configuration > Fabric > Nodes > User Management > Users Remove SSH public key from authorized_keys file for node user |
POST /node/users/{userid}/ssh-keys?action=remove_ssh_key
|
| System Administration > Configuration > Grub Return node GRUB properties |
GET /node/grub
|
| System Administration > Configuration > Grub Update node GRUB properties |
PUT /node/grub
|
| System Administration > Configuration > Grub Update node GRUB user properties |
PUT /node/grub/{grub-username}
|
| System Administration > Configuration > System Properties > Dataplane Get NSX Edge dataplane geneve cbit setting |
GET /node/services/dataplane/geneve-cbit
|
| System Administration > Configuration > System Properties > Dataplane Update NSX Edge dataplane geneve cbit setting |
PUT /node/services/dataplane/geneve-cbit
|
| System Administration > Configuration > System Properties > Dataplane Get the physical port statistics |
GET /node/services/dataplane/physical-ports/{physical-port}/stats
|
| System Administration > Configuration > System Properties > Dataplane Get the physical port extended statistics |
GET /node/services/dataplane/physical-ports/{physical-port}/xstats
|
| System Administration > Lifecycle Management > Backup Create backup for autonomous edge node in primary_api_node role |
GET /backup
|
| System Administration > Lifecycle Management > Restore Perform restore on autonomous edge in primary_api_node role |
POST /restore
|
| System Administration > Lifecycle Management > Upgrade > Nodes Get upgrade task status |
GET /node/upgrade
(Deprecated)
|
| System Administration > Lifecycle Management > Upgrade > Nodes Execute upgrade task |
POST /node/upgrade/performtask
|
| System Administration > Lifecycle Management > Upgrade > Nodes Get upgrade progress status |
GET /node/upgrade/progress-status
|
| System Administration > Lifecycle Management > Upgrade > Nodes Get upgrade status summary |
GET /node/upgrade/status-summary
|
| System Administration > Monitoring > Logs > Core Dumps Update node core dump configuration |
POST /node?action=set_coredump_config
|
| System Administration > Monitoring > Logs > Core Dumps List system core dumps |
GET /node/core-dumps
|
| System Administration > Monitoring > Logs > Core Dumps Delete core dump file |
DELETE /node/core-dumps/{file-name}
|
| System Administration > Monitoring > Logs > Core Dumps Copy system generated core dump file to a remote file store |
POST /node/core-dumps/{file-name}?action=copy_to_remote_file
|
| System Administration > Settings > Certificates > CRL Return All Added CRLs |
GET /trust-management/crls
|
| System Administration > Settings > Certificates > CRL Add a New Certificate Revocation List |
POST /trust-management/crls
|
| System Administration > Settings > Certificates > CRL Delete a CRL |
DELETE /trust-management/crls/{crl-id}
|
| System Administration > Settings > Certificates > CRL Show CRL Data for the Given CRL ID |
GET /trust-management/crls/{crl-id}
|
| System Administration > Settings > Certificates > CRL Update CRL for the Given CRL ID |
PUT /trust-management/crls/{crl-id}
|
| System Administration > Settings > Certificates > Certificate Return All the User-Facing Components' Certificates |
GET /trust-management/certificates
|
| System Administration > Settings > Certificates > Certificate Add a New Certificate |
POST /trust-management/certificates
|
| System Administration > Settings > Certificates > Certificate Delete Certificate for the Given Certificate ID |
DELETE /trust-management/certificates/{cert-id}
|
| System Administration > Settings > Certificates > Certificate Show Certificate Data for the Given Certificate ID |
GET /trust-management/certificates/{cert-id}
|
| System Administration > Settings > Certificates > Certificate Update certificate for the given certificate ID |
PUT /trust-management/certificates/{cert-id}
|
| VPN > IPSEC > DPD Profiles Get IPSec dead peer detection (DPD) profile list result |
GET /vpn/ipsec/dpd-profiles
|
| VPN > IPSEC > DPD Profiles Create dead peer detection (DPD) profile |
POST /vpn/ipsec/dpd-profiles
|
| VPN > IPSEC > DPD Profiles Delete dead peer detection (DPD) profile |
DELETE /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}
|
| VPN > IPSEC > DPD Profiles Get IPSec dead peer detection (DPD) profile |
GET /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}
|
| VPN > IPSEC > DPD Profiles Edit IPSec dead peer detection (DPD) profile |
PUT /vpn/ipsec/dpd-profiles/{ipsec-vpn-dpd-profile-id}
|
| VPN > IPSEC > IKE Profiles List IKE profiles |
GET /vpn/ipsec/ike-profiles
|
| VPN > IPSEC > IKE Profiles Create custom internet key exchange (IKE) Profile |
POST /vpn/ipsec/ike-profiles
|
| VPN > IPSEC > IKE Profiles Delete custom IKE Profile |
DELETE /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}
|
| VPN > IPSEC > IKE Profiles Get IKE Profile |
GET /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}
|
| VPN > IPSEC > IKE Profiles Edit custom IKE Profile |
PUT /vpn/ipsec/ike-profiles/{ipsec-vpn-ike-profile-id}
|
| VPN > IPSEC > Multi Path Groups Get IPSec multipath group list result |
GET /vpn/ipsec/multi-path-groups
|
| VPN > IPSEC > Multi Path Groups Create custom IPSec VPN multipath group |
POST /vpn/ipsec/multi-path-groups
|
| VPN > IPSEC > Multi Path Groups Delete custom IPSec multipath group |
DELETE /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}
|
| VPN > IPSEC > Multi Path Groups Get IPSec multipath group |
GET /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}
|
| VPN > IPSEC > Multi Path Groups Update custom IPSec multipath group |
PUT /vpn/ipsec/multi-path-groups/{ipsec-multi-path-group-id}
|
| VPN > IPSEC > Service Get IPSec VPN service |
GET /vpn/ipsec/service
|
| VPN > IPSEC > Service Edit IPSec VPN service |
PUT /vpn/ipsec/service
|
| VPN > IPSEC > Sessions Get IPSec VPN session list result |
GET /vpn/ipsec/sessions
|
| VPN > IPSEC > Sessions Create new VPN session |
POST /vpn/ipsec/sessions
|
| VPN > IPSEC > Sessions Delete IPSec VPN session |
DELETE /vpn/ipsec/sessions/{ipsec-vpn-session-id}
|
| VPN > IPSEC > Sessions Fetch IPSec VPN session |
GET /vpn/ipsec/sessions/{ipsec-vpn-session-id}
|
| VPN > IPSEC > Sessions Fetch IPSec VPN session with PSK |
GET /vpn/ipsec/sessions/{ipsec-vpn-session-id}?action=show-sensitive-data
|
| VPN > IPSEC > Sessions Edit IPSec VPN session |
PUT /vpn/ipsec/sessions/{ipsec-vpn-session-id}
|
| VPN > IPSEC > Statistics Get IPSec VPN session statistics |
GET /vpn/ipsec/sessions/{session-id}/statistics
|
| VPN > IPSEC > Tunnel Profiles Get IPSecTunnelProfile List Result |
GET /vpn/ipsec/tunnel-profiles
|
| VPN > IPSEC > Tunnel Profiles Create custom IPSec tunnel profile |
POST /vpn/ipsec/tunnel-profiles
|
| VPN > IPSEC > Tunnel Profiles Delete custom IPSecTunnelProfile |
DELETE /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}
|
| VPN > IPSEC > Tunnel Profiles Get IPSec tunnel profile |
GET /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}
|
| VPN > IPSEC > Tunnel Profiles Edit custom IPSecTunnelProfile |
PUT /vpn/ipsec/tunnel-profiles/{ipsec-vpn-tunnel-profile-id}
|