NSX Autonomous Edge REST API
Associated URIs:
| API Description | API Path |
|---|---|
Read node authentication policy configurationReturns information about the currently configured authentication policies on the node. |
GET /api/v1/node/aaa/auth-policy
|
Update node authentication policy configurationUpdate the currently configured authentication policy on the node. If any of api_max_auth_failures, api_failed_auth_reset_period, or api_failed_auth_lockout_period are modified, the http service is automatically restarted. |
PUT /api/v1/node/aaa/auth-policy
|
List node usersReturns the list of users configured to log in to the NSX appliance. |
GET /api/v1/node/users
|
Read node userReturns information about a specified user who is configured to log in to the NSX appliance. The valid user IDs are: 0, 10000, 10002. |
GET /api/v1/node/users/<userid>
|
Update node userUpdates attributes of an existing NSX appliance user. This method cannot be used to add a new user. Modifiable attributes include the username, full name of the user, and password. If you specify a password in a PUT request, it is not returned in the response. Nor is it returned in a GET request. The specified password does not 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 - minimum 5 unique characters - default password complexity rules as enforced by the Linux PAM module The valid user IDs are: 0, 10000, 10002. Note that invoking this API does not update any user-related properties of existing objects in the system and does not modify the username field in existing audit log entries. |
PUT /api/v1/node/users/<userid>
|
List SSH keys from authorized_keys file for node userReturns a list of all SSH keys from authorized_keys file for node user |
GET /api/v1/node/users/<userid>/ssh-keys
|
Remove SSH public key from authorized_keys file for node user |
POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key
|
Add SSH public key to authorized_keys file for node user |
POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key
|
Additional
Links