NSX Autonomous Edge REST API

Associated URIs:

API Description API Path

Create backup for autonomous edge node in primary_api_node role


Create passphrase protected backup file for autonomous edge node in primary_api_node role.
Passphrase must be provided in request header.
The passphrase must meet the following complexity requirements -
- minimum 12 characters in length
- minimum 1 uppercase character
- minimum 1 lowercase character
- minimum 1 numeric character
- minimum 1 special character
Backup is only allowed on autonomous edge node in primary_api_node role.
For autonomous edge not in primary_api_node role, does not need backups.
Configurations are kept in sync internally from the primary_api_node to the
peer node in the high availibility cluster
GET /backup

Get upgrade task status


Get upgrade task status for the given task of the given bundle.
Both bundle_name and task_id must be provided, otherwise you
will receive a 404 NOT FOUND response. This api is deprecated.
Please use API GET /node/upgrade/status-summary to get upgrade
status when upgrade is in progress.
GET /node/upgrade (Deprecated)

Execute upgrade task


Execute upgrade task.
POST /node/upgrade/performtask

Get upgrade progress status


Get progress status of last upgrade step, if upgrade bundle is present.
GET /node/upgrade/progress-status

Get upgrade status summary


Get status summary of node upgrade, if upgrade bundle is present.
GET /node/upgrade/status-summary

Perform restore on autonomous edge in primary_api_node role


Restore autonomous edge in primary_api_node using the passphrase protected backup file.
Passphrase must be provided in request header.
This operation is not supported on autonomous edge not in primary_api_node role.
If you need to restore such a node, please deploy a new autonomous edge VM in
secondary_api_node role and register it with an existing autonomous edge in primary_api_node role.
If the high availability cluster of existing autonomous edge in primary_api_node role
already has another autonomous edge node, delete the other node before registering a new one.
The configuration from primary_api_node autonomous edge will replicate to the peer node
in the high availibility cluster.
POST /restore