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 for HCX
POST /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
Update an L2VPN session with new details for HCX
PUT /vpn/l2vpn/sessions/{l2vpn-session-id}
Logical Routing And Services Configuration > VPN > L2VPN
Get L2VPN session statistics
GET /vpn/l2vpn/sessions/{l2vpn-session-id}/statistics
System (Administration) > Certificates
Return All the User-Facing Components' Certificates
GET /trust-management/certificates
System (Administration) > Certificates
Add a New Certificate
POST /trust-management/certificates
System (Administration) > Certificates
Delete Certificate for the Given Certificate ID
DELETE /trust-management/certificates/{cert-id}
System (Administration) > Certificates
Show Certificate Data for the Given Certificate ID
GET /trust-management/certificates/{cert-id}
System (Administration) > Certificates
Update certificate for the given certificate ID
PUT /trust-management/certificates/{cert-id}
System (Administration) > Certificates
Return All Added CRLs
GET /trust-management/crls
System (Administration) > Certificates
Add a New Certificate Revocation List
POST /trust-management/crls
System (Administration) > Certificates
Delete a CRL
DELETE /trust-management/crls/{crl-id}
System (Administration) > Certificates
Show CRL Data for the Given CRL ID
GET /trust-management/crls/{crl-id}
System (Administration) > Certificates
Update CRL for the Given CRL ID
PUT /trust-management/crls/{crl-id}
System (Administration) > Grub
Return node GRUB properties
GET /node/grub
System (Administration) > Grub
Update node GRUB properties
PUT /node/grub
System (Administration) > Grub
Update node GRUB user properties
PUT /node/grub/{grub-username}
System (Administration) > Monitoring
Update node core dump configuration
POST /node?action=set_coredump_config
System (Administration) > Monitoring
List system core dumps
GET /node/core-dumps
System (Administration) > Monitoring
Delete core dump file
DELETE /node/core-dumps/{file-name}
System (Administration) > Monitoring
Copy system generated core dump file to a remote file store
POST /node/core-dumps/{file-name}?action=copy_to_remote_file
System (Administration) > Monitoring
List available node logs
GET /node/logs
System (Administration) > Monitoring
Read node log properties
GET /node/logs/{log-name}
System (Administration) > Monitoring
Read node log contents
GET /node/logs/{log-name}/data
System (Administration) > NSX Manager (Local Controller Service)
Update NSX Edge NSXA service properties
PUT /node/services/local-controller
System (Administration) > Support Bundle
Read node support bundle
GET /node/support-bundle
System (Administration) > Transport Nodes
List node services
GET /node/services
System (Administration) > Transport Nodes (Dns)
Read the Node's Name Servers
GET /node/network/name-servers
System (Administration) > Transport Nodes (Dns)
Update the Node's Name Servers
PUT /node/network/name-servers
System (Administration) > Transport Nodes (Dns)
Read the Node's Search Domains
GET /node/network/search-domains
System (Administration) > Transport Nodes (Dns)
Update the Node's Search Domains
PUT /node/network/search-domains
System (Administration) > Transport Nodes (Interfaces)
Read network configuration properties
GET /node/network
System (Administration) > Transport Nodes (Interfaces)
List the Node's Network Interfaces
GET /node/network/interfaces
System (Administration) > Transport Nodes (Interfaces)
Read the Node's Network Interface
GET /node/network/interfaces/{interface-id}
System (Administration) > Transport Nodes (Interfaces)
Update the Node's Network Interface
PUT /node/network/interfaces/{interface-id}
System (Administration) > Transport Nodes (Interfaces)
Read the Node's Network Interface Statistics
GET /node/network/interfaces/{interface-id}/stats
System (Administration) > Transport Nodes (Log Insight)
Read liagent service properties
GET /node/services/liagent
System (Administration) > Transport Nodes (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) > Transport Nodes (Log Insight)
Read liagent service status
GET /node/services/liagent/status
System (Administration) > Transport Nodes (Ntp Service)
Read NTP service properties
GET /node/services/ntp
System (Administration) > Transport Nodes (Ntp Service)
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) > Transport Nodes (Ntp Service)
Update NTP service properties
PUT /node/services/ntp
System (Administration) > Transport Nodes (Ntp Service)
Read NTP service status
GET /node/services/ntp/status
System (Administration) > Transport Nodes (Snmp Service)
Read SNMP service properties
GET /node/services/snmp
System (Administration) > Transport Nodes (Snmp Service)
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) > Transport Nodes (Snmp Service)
Update SNMP service properties
PUT /node/services/snmp
System (Administration) > Transport Nodes (Snmp Service)
Read SNMP service status
GET /node/services/snmp/status
System (Administration) > Transport Nodes (Snmp Service)
Read SNMP V3 Engine ID
GET /node/services/snmp/v3-engine-id
System (Administration) > Transport Nodes (Snmp Service)
Update SNMP V3 Engine ID
PUT /node/services/snmp/v3-engine-id
System (Administration) > Transport Nodes (Ssh Service)
Clear SSH login banner
DELETE /node/services/ssh?action=clear_banner
System (Administration) > Transport Nodes (Ssh Service)
Read ssh service properties
GET /node/services/ssh
System (Administration) > Transport Nodes (Ssh Service)
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) > Transport Nodes (Ssh Service)
Remove a host's fingerprint from known hosts file
POST /node/services/ssh?action=remove_host_fingerprint
System (Administration) > Transport Nodes (Ssh Service)
Update ssh service properties
PUT /node/services/ssh
System (Administration) > Transport Nodes (Ssh Service)
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) > Transport Nodes (Ssh Service)
Read ssh service status
GET /node/services/ssh/status
System (Administration) > Transport Nodes (Syslog Service)
Read syslog service properties
GET /node/services/syslog
System (Administration) > Transport Nodes (Syslog Service)
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) > Transport Nodes (Syslog Service)
Delete all node syslog exporters
DELETE /node/services/syslog/exporters
System (Administration) > Transport Nodes (Syslog Service)
List node syslog exporters
GET /node/services/syslog/exporters
System (Administration) > Transport Nodes (Syslog Service)
Verify node syslog exporter
POST /node/services/syslog/exporters?action=verify
System (Administration) > Transport Nodes (Syslog Service)
Delete all node syslog exporters not managed by VCF Operations
POST /node/services/syslog/exporters?action=delete_all_non_vcf_ops_managed_exporters
System (Administration) > Transport Nodes (Syslog Service)
Add node syslog exporter
POST /node/services/syslog/exporters
System (Administration) > Transport Nodes (Syslog Service)
Delete node syslog exporter
DELETE /node/services/syslog/exporters/{exporter-name}
System (Administration) > Transport Nodes (Syslog Service)
Read node syslog exporter
GET /node/services/syslog/exporters/{exporter-name}
System (Administration) > Transport Nodes (Syslog Service)
Read syslog service status
GET /node/services/syslog/status
System (Administration) > Transport Nodes (Tasks Service)
List appliance management tasks
GET /node/tasks
System (Administration) > Transport Nodes (Tasks Service)
Delete task
DELETE /node/tasks/{task-id}
System (Administration) > Transport Nodes (Tasks Service)
Read task properties
GET /node/tasks/{task-id}
System (Administration) > Transport Nodes (Tasks Service)
Cancel specified task
POST /node/tasks/{task-id}?action=cancel
System (Administration) > Transport Nodes (Tasks Service)
Read asynchronous task response
GET /node/tasks/{task-id}/response
System (Administration) > Transport Nodes (Upgrade Agent Service)
Read NSX upgrade Agent service properties
GET /node/services/nsx-upgrade-agent
System (Administration) > Transport Nodes (Upgrade Agent Service)
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) > Transport Nodes (Upgrade Agent Service)
Read Nsx upgrade agent service status
GET /node/services/nsx-upgrade-agent/status
System (Fabric) > Transport Nodes (User Management)
Read node authentication policy and password complexity configuration
GET /node/aaa/auth-policy
System (Fabric) > Transport Nodes (User Management)
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 (Fabric) > Transport Nodes (User Management)
Update node authentication policy and password complexity configuration
PUT /node/aaa/auth-policy
System (Fabric) > Edge Transport Nodes
Read NSX Nestdb service properties
GET /node/services/nestdb
System (Fabric) > Edge Transport Nodes
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 (Fabric) > Edge Transport Nodes
Read NSX Nestdb service status
GET /node/services/nestdb/status
System (Fabric) > Edge Transport Nodes
Read NSX EdgeMSR service properties
GET /node/services/router
System (Fabric) > Edge Transport Nodes
Read NSX EdgeMSRConfig service properties
GET /node/services/router-config
System (Fabric) > Edge Transport Nodes
Read NSX EdgeMSRConfig service status
GET /node/services/router-config/status
System (Fabric) > Edge Transport Nodes
Read NSX EdgeMSR service status
GET /node/services/router/status
System (Fabric) > Edge Transport Nodes (Dataplane)
Read NSX EdgeDatapath service properties
GET /node/services/dataplane
System (Fabric) > Edge Transport Nodes (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 (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge Datapath service properties
PUT /node/services/dataplane
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane cpu stats
GET /node/services/dataplane/cpu-stats
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane control packets prioritization setting
PUT /node/services/dataplane/ctrl-prio
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane flow cache setting
GET /node/services/dataplane/flow-cache
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane flow cache setting
PUT /node/services/dataplane/flow-cache
System (Fabric) > Edge Transport Nodes (Dataplane)
Return top 10 flows information
GET /node/services/dataplane/flow-mon
System (Fabric) > Edge Transport Nodes (Dataplane)
Start NSX Edge dataplane flow monitor
PUT /node/services/dataplane/flow-mon
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane geneve cbit setting
GET /node/services/dataplane/geneve-cbit
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane geneve cbit setting
PUT /node/services/dataplane/geneve-cbit
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane interrupt mode setting
PUT /node/services/dataplane/intr-mode
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane l2vpn pmtu message generation setting
GET /node/services/dataplane/l2vpn-pmtu
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane l2vpn pmtu message generation setting
PUT /node/services/dataplane/l2vpn-pmtu
System (Fabric) > Edge Transport Nodes (Dataplane)
Get the physical port statistics
GET /node/services/dataplane/physical-ports/{physical-port}/stats
System (Fabric) > Edge Transport Nodes (Dataplane)
Get the physical port extended statistics
GET /node/services/dataplane/physical-ports/{physical-port}/xstats
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane pmtu learning setting
GET /node/services/dataplane/pmtu-learning
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane pmtu learning setting
PUT /node/services/dataplane/pmtu-learning
System (Fabric) > Edge Transport Nodes (Dataplane)
Update NSX Edge dataplane QAT feature enabled status
PUT /node/services/dataplane/qat-enable
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge dataplane QAT setting
GET /node/services/dataplane/qat-status
System (Fabric) > Edge Transport Nodes (Dataplane)
Get NSX Edge rx and tx queue number per port per core
GET /node/services/dataplane/queue-num-per-port-per-core
System (Fabric) > Edge Transport Nodes (Dataplane)
Set NSX Edge rx and tx queue number per port per core
PUT /node/services/dataplane/queue-num-per-port-per-core
System (Fabric) > Edge Transport Nodes (Dataplane)
Return rx/tx ring size information
GET /node/services/dataplane/ring-size
System (Fabric) > Edge Transport Nodes (Dataplane)
Set NSX Edge rx ring size for physical ports
PUT /node/services/dataplane/rx-ring-size
System (Fabric) > Edge Transport Nodes (Dataplane)
Read NSX EdgeDatapath service status
GET /node/services/dataplane/status
System (Fabric) > Edge Transport Nodes (Dataplane)
Set NSX Edge tx ring size for physical ports
PUT /node/services/dataplane/tx-ring-size
System (Fabric) > Edge Transport Nodes (Dataplane)
Check UPT mode enabled status of NSX Edge dataplane
GET /node/services/dataplane/upt-mode
System (Fabric) > Edge Transport Nodes (Diagnosis)
Read edge config diagnosis
GET /node/diagnosis
System (Fabric) > Edge Transport Nodes (Diagnosis)
Read edge diagnosis inconsistency
GET /node/diagnosis/inconsistency
System (Fabric) > Edge Transport Nodes (Diagnosis)
Logical-router diagnosis
GET /node/logical-routers/{logical-router-id}/diagnosis
System (Fabric) > Edge Transport Nodes (Diagnosis)
Logical-routers diagnosis
GET /node/logical-routers/diagnosis
System (Fabric) > Edge Transport Nodes (Ipsec VPN Service)
Read NSX Edge Ipsec VPN service properties
GET /node/services/ipsecvpn
System (Fabric) > Edge Transport Nodes (Ipsec VPN Service)
Update NSX Edge Ipsec VPN service properties
PUT /node/services/ipsecvpn
System (Fabric) > Edge Transport Nodes (Ipsec VPN Service)
Read NSX Edge Ipsec VPN service status
GET /node/services/ipsecvpn/status
System (Fabric) > Edge Transport Nodes (Local Controller)
Read NSX Edge NSXA service properties
GET /node/services/local-controller
System (Fabric) > Edge Transport Nodes (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 (Fabric) > Edge Transport Nodes (Local Controller)
Read NSX EdgeNSXA service status
GET /node/services/local-controller/status
System (Fabric) > Edge Transport Nodes (Maintenance Mode)
Get Edge maintenance mode
GET /node/maintenance-mode
System (Fabric) > Edge Transport Nodes (Maintenance Mode)
Set Edge maintenance mode
PUT /node/maintenance-mode
System (Fabric) > Edge Transport Nodes (Services)
Read NSX Edge Docker service properties
GET /node/services/docker
System (Fabric) > Edge Transport Nodes (Services)
Read NSX Edge Docker service status
GET /node/services/docker/status
System (Fabric) > Hardening
Gets the enable status for Mandatory Access Control
GET /node/hardening-policy/mandatory-access-control
System (Fabric) > Hardening
Enable or disable Mandatory Access Control
PUT /node/hardening-policy/mandatory-access-control
System (Fabric) > Hardening
Get the report for Mandatory Access Control
GET /node/hardening-policy/mandatory-access-control/report
System (Fabric) > Transport Nodes
Read node properties
GET /node
System (Fabric) > Transport Nodes
Restart or shutdown node
POST /node?action=restart
POST /node?action=shutdown
System (Fabric) > Transport Nodes
Set the node system time
POST /node?action=set_system_time
System (Fabric) > Transport Nodes
Update node properties
PUT /node
System (Fabric) > Transport Nodes
Delete directory in remote file server
DELETE /node/file-store?action=delete_remote_directory
System (Fabric) > Transport Nodes
List node files
GET /node/file-store
System (Fabric) > Transport Nodes
Retrieve ssh fingerprint for given remote server
POST /node/file-store?action=retrieve_ssh_fingerprint
System (Fabric) > Transport Nodes
Create directory in remote file server
POST /node/file-store?action=create_remote_directory
System (Fabric) > Transport Nodes
Retrieve matching host key algorithm for the ssh fingerprint provided
POST /node/file-store?action=retrieve_matching_host_key_algorithm
System (Fabric) > Transport Nodes
Delete file
DELETE /node/file-store/{file-name}
System (Fabric) > Transport Nodes
Read file properties
GET /node/file-store/{file-name}
System (Fabric) > Transport Nodes
Copy file in the file store to a remote file store
POST /node/file-store/{file-name}?action=copy_to_remote_file
System (Fabric) > Transport Nodes
Upload a file to the file store
POST /node/file-store/{file-name}
System (Fabric) > Transport Nodes
Copy a remote file to the file store
POST /node/file-store/{file-name}?action=copy_from_remote_file
System (Fabric) > Transport Nodes
Read file contents
GET /node/file-store/{file-name}/data
System (Fabric) > Transport Nodes
Replace file contents
PUT /node/file-store/{file-name}/data
System (Fabric) > Transport Nodes
Read file thumbprint
GET /node/file-store/{file-name}/thumbprint
System (Fabric) > Transport Nodes
Read node message of the day
GET /node/motd
System (Fabric) > Transport Nodes
List node network routes
GET /node/network/routes
System (Fabric) > Transport Nodes
Create node network route
POST /node/network/routes
System (Fabric) > Transport Nodes
Delete node network route
DELETE /node/network/routes/{route-id}
System (Fabric) > Transport Nodes
Read node network route
GET /node/network/routes/{route-id}
System (Fabric) > Transport Nodes
List node processes
GET /node/processes
System (Fabric) > Transport Nodes
Read node process
GET /node/processes/{process-id}
System (Fabric) > Transport Nodes
Read appliance management service properties
GET /node/services/node-mgmt
System (Fabric) > Transport Nodes
Restart the node management service
POST /node/services/node-mgmt?action=restart
System (Fabric) > Transport Nodes
Retrieve Node Management loglevel
GET /node/services/node-mgmt/loglevel
System (Fabric) > Transport Nodes
Set Node Management loglevel
PUT /node/services/node-mgmt/loglevel
System (Fabric) > Transport Nodes
Read appliance management service status
GET /node/services/node-mgmt/status
System (Fabric) > Transport Nodes
Read NSX Platform Client service properties
GET /node/services/nsx-platform-client
System (Fabric) > Transport Nodes
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 (Fabric) > Transport Nodes
Read NSX Platform Client service status
GET /node/services/nsx-platform-client/status
System (Fabric) > Transport Nodes
Read node status
GET /node/status
System (Fabric) > Transport Nodes
Update node status
POST /node/status?action=clear_bootup_error
System (Fabric) > Transport Nodes
Read node version
GET /node/version
System (Fabric) > Transport Nodes (User Management)
List node users
GET /node/users
System (Fabric) > Transport Nodes (User Management)
Delete node user
DELETE /node/users/{userid}
System (Fabric) > Transport Nodes (User Management)
Read node user
GET /node/users/{userid}
System (Fabric) > Transport Nodes (User Management)
Reset a user's password without requiring their current password
POST /node/users/{userid}?action=reset_password
System (Fabric) > Transport Nodes (User Management)
Update node user
PUT /node/users/{userid}
System (Fabric) > Transport Nodes (User Management)
List SSH keys from authorized_keys file for node user
GET /node/users/{userid}/ssh-keys
System (Fabric) > Transport Nodes (User Management)
Add SSH public key to authorized_keys file for node user
POST /node/users/{userid}/ssh-keys?action=add_ssh_key
System (Fabric) > Transport Nodes (User Management)
Remove SSH public key from authorized_keys file for node user
POST /node/users/{userid}/ssh-keys?action=remove_ssh_key
System (Lifecycle Management) > Upgrade (Nodes)
Get upgrade task status
GET /node/upgrade (Deprecated)
System (Lifecycle Management) > Upgrade (Nodes)
Execute upgrade task
POST /node/upgrade/performtask
System (Lifecycle Management) > Upgrade (Nodes)
Get upgrade progress status
GET /node/upgrade/progress-status
System (Lifecycle Management) > Upgrade (Nodes)
Get upgrade status summary
GET /node/upgrade/status-summary
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 > 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 > 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 > Settings
List node FIPs modules
GET /node/fips/modules
GET /node/fips/modules?component_name=nsx-manager
GET /node/fips/modules?component_name=nsx-global-manager
GET /node/fips/modules?component_name=nsx-edge
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
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}