NSX-T Data Center REST API

Associated URIs:

API Description	API Path
Read Cluster Configuration Returns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as "roles." These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters.	GET /api/v1/cluster
Join this node to a NSX Cluster	POST /api/v1/cluster?action=join_cluster
Read cluster node configuration Returns information about the specified NSX cluster node.	GET /api/v1/cluster/{node-id}
Detach a node from the Cluster	POST /api/v1/cluster/{node-id}?action=remove_node
Invoke DELETE request on target cluster node	DELETE /api/v1/cluster/{target-node-id}/{target-uri}
Invoke GET request on target cluster node	GET /api/v1/cluster/{target-node-id}/{target-uri}
Invoke POST request on target cluster node	POST /api/v1/cluster/{target-node-id}/{target-uri}
Invoke PUT request on target cluster node	PUT /api/v1/cluster/{target-node-id}/{target-uri}
Get backup frames for UI Returns list of backup frames and some metadata to be used by UI.	GET /api/v1/cluster/backups/ui_frames
Synchronizes the repository data between nsx managers. Attempts to synchronize the repository partition on nsx manager. Repository partition contains packages required for the install and upgrade of nsx components.Normally there is no need to call this API explicitely by the user.	POST /api/v1/cluster/node?action=repo_sync
List Cluster Node Configurations Returns information about all NSX cluster nodes.	GET /api/v1/cluster/nodes
Add a controller to the cluster Add a new controller to the NSX cluster. The controller comes with the new node.	POST /api/v1/cluster/nodes (Deprecated)
Remove a controller from the cluster Removes the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the "stop service controller" command.	DELETE /api/v1/cluster/nodes/{node-id} (Deprecated)
Read Cluster Node Configuration Returns information about the specified NSX cluster node.	GET /api/v1/cluster/nodes/{node-id} (Deprecated)
Synchronizes the repository data between nsx managers. Returns the synchronization status for the manager represented by given <node-id>.	GET /api/v1/cluster/nodes/{node-id}/repo_sync/status
Read cluster node runtime status Read aggregated runtime status of cluster node.	GET /api/v1/cluster/nodes/{node-id}/status
Returns info for all cluster node VM auto-deployment attempts Returns request information for every attempted deployment of a cluster node VM.	GET /api/v1/cluster/nodes/deployments
Deploy and register a cluster node VM Deploys a cluster node VM as specified by the deployment config. Once the VM is deployed and powered on, it will automatically join the existing cluster.	POST /api/v1/cluster/nodes/deployments
Returns info for a cluster-node VM auto-deployment attempt Returns deployment request information for a specific attempted deployment of a cluster node VM.	GET /api/v1/cluster/nodes/deployments/{node-id}
Attempt to delete an auto-deployed cluster node VM Attempts to unregister and undeploy a specified auto-deployed cluster node VM. If it is a member of a cluster, then the VM will be automatically detached from the cluster before being unregistered and undeployed. Alternatively, if the original deployment attempt failed or the VM is not found, cleans up the deployment information associated with the deployment attempt. Note: If a VM has been successfully auto-deployed, then the associated deployment information will not be deleted unless and until the VM is successfully deleted.	POST /api/v1/cluster/nodes/deployments/{node-id}?action=delete
Returns the status of the VM creation/deletion Returns the current deployment or undeployment status for a VM along with any other relevant current information, such as error messages.	GET /api/v1/cluster/nodes/deployments/{node-id}/status
Read cluster runtime status Read aggregated runtime status of all cluster nodes. Deprecated. Use GET /cluster/status instead.	GET /api/v1/cluster/nodes/status (Deprecated)
Read Cluster Status Returns status information for the NSX cluster control role and management role.	GET /api/v1/cluster/status