Associated URIs:

API Description	API Path
Register a Collection of API Calls at a Single End Point Enables you to make multiple API requests using a single request. The batch API takes in an array of logical HTTP requests represented as JSON arrays. Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the portion of the URL after https://<nsx-mgr>/api/), optional headers array (corresponding to HTTP headers) and an optional body (for POST and PUT requests). The batch API returns an array of logical HTTP responses represented as JSON arrays. Each response has a status code, an optional headers array and an optional body (which is a JSON-encoded string). The batch API is not supported for any of the policy multi-tenancy related APIs. The multi-tenancy APIs start with the path /orgs//projects// This API is deprecated. Instead, use the hierarchical API in the NSX-T policy API.	POST /policy/api/v1/batch (Deprecated) POST /api/v1/batch (Deprecated)
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}
Read cluster certificate ID Returns the ID of the certificate that is used as the cluster certificate for MP	GET /api/v1/cluster/api-certificate
Clear the cluster certificate Clears the certificate used for the MP cluster. This does not affect the certificate itself. This API is deprecated. Instead use the /api/v1/cluster/api-certificate?action=set_cluster_certificate API to set the cluster certificate to a different one. It just means that from now on, individual certificates will be used on each MP node. This affects all nodes in the cluster.	POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)
Set the cluster certificate Sets the certificate used for the MP cluster. This affects all nodes in the cluster. If the certificate used is a CA signed certificate,the request fails if the whole chain(leaf, intermediate, root) is not imported.	POST /api/v1/cluster/api-certificate?action=set_cluster_certificate (Deprecated)
Read API service properties Read the configuration of the NSX API service.	GET /api/v1/cluster/api-service
Update API service properties Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.	PUT /api/v1/cluster/api-service
Read cluster virtual IP addresses Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.	GET /api/v1/cluster/api-virtual-ip
Clear cluster virtual IP address Clears the cluster virtual IPv4 or IPv6 address. Note, query parameter ?action=clear_virtual_ip clears virtual IPv4 address and ?action=clear_virtual_ip6 clears virtual IPv6 address.	POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip6
Set cluster virtual IP addresses Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management cluster must be in the same subnet. If not, a 409 CONFLICT status is returned. Query parameter ip_address sets virtual IPv4 address and ip6_address sets virtual IPv6 address; either or both of the parameters can be specified to set virtual IP address(es). When updating either of any one parameter value this does not changes the value of other unspecified parameter.	POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip
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)
List the specified node's Network Interfaces Returns the number of interfaces on the node and detailed information about each interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP). Note that if virtual IP (VIP) addresses are configured, virtual interfaces will not be returned.	GET /api/v1/cluster/nodes/{node-id}/network/interfaces
Read the node's Network Interface Returns detailed information about the specified interface. Interface information includes MTU, broadcast and host IP addresses, link and admin status, MAC address, network mask, and the IP configuration method (static or DHCP).	GET /api/v1/cluster/nodes/{node-id}/network/interfaces/{interface-id}
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
Read NSX Management nodes global configuration. Returns the NSX Management nodes global configuration.	GET /policy/api/v1/configs/management GET /api/v1/configs/management
Update NSX Management nodes global configuration Modifies the NSX Management nodes global configuration.	PUT /policy/api/v1/configs/management PUT /api/v1/configs/management
NodeMode Currently only a switch from "VMC_LOCAL" to "VMC" is supported. Returns a new Node Mode, if the request successfuly changed it. Optionally provisions public oauth2 client info.	POST /api/v1/configs/node/mode
Update the async_replicator service properties	PUT /api/v1/cluster/{cluster-node-id}/node/services/async_replicator PUT /api/v1/node/services/async_replicator
Read auth service properties Read auth service properties.	GET /api/v1/cluster/{cluster-node-id}/node/services/auth GET /api/v1/node/services/auth
Restart the auth service	POST /api/v1/cluster/{cluster-node-id}/node/services/auth?action=restart POST /api/v1/node/services/auth?action=restart
Stop the auth service	POST /api/v1/cluster/{cluster-node-id}/node/services/auth?action=stop POST /api/v1/node/services/auth?action=stop
Start the auth service	POST /api/v1/cluster/{cluster-node-id}/node/services/auth?action=start POST /api/v1/node/services/auth?action=start
Update auth service properties Update auth service properties.	PUT /api/v1/cluster/{cluster-node-id}/node/services/auth PUT /api/v1/node/services/auth
Read auth service status	GET /api/v1/cluster/{cluster-node-id}/node/services/auth/status GET /api/v1/node/services/auth/status
Get information about all tasks	GET /policy/api/v1/tasks GET /api/v1/tasks
Get information about the specified task	GET /policy/api/v1/tasks/{task-id} GET /api/v1/tasks/{task-id}
Get the response of a task	GET /policy/api/v1/tasks/{task-id}/response GET /api/v1/tasks/{task-id}/response
Delete deployment information. This is an API called by VCF to delete deployment information.	DELETE /api/v1/watermark
Get deployment information. This is an API called by VCF to get deployment information.	GET /api/v1/watermark
Create or update deployment information. This is an API called by VCF to store or update deployment information.	POST /api/v1/watermark
Create or update deployment information. This is an API called by VCF to update stored deployment information.	PUT /api/v1/watermark

System Administration > Configuration > NSX Managers

Associated URIs:

Register a Collection of API Calls at a Single End Point

Read Cluster Configuration

Join this node to a NSX Cluster

Read cluster node configuration

Detach a node from the Cluster

Invoke DELETE request on target cluster node

Invoke GET request on target cluster node

Invoke POST request on target cluster node

Invoke PUT request on target cluster node

Read cluster certificate ID

Clear the cluster certificate

Set the cluster certificate

Read API service properties

Update API service properties

Read cluster virtual IP addresses

Clear cluster virtual IP address

Set cluster virtual IP addresses

Get backup frames for UI

Synchronizes the repository data between nsx managers.

List Cluster Node Configurations

Add a controller to the cluster

Remove a controller from the cluster

Read Cluster Node Configuration

List the specified node's Network Interfaces

Read the node's Network Interface

Synchronizes the repository data between nsx managers.

Read cluster node runtime status

Returns info for all cluster node VM auto-deployment attempts

Deploy and register a cluster node VM

Returns info for a cluster-node VM auto-deployment attempt

Attempt to delete an auto-deployed cluster node VM

Returns the status of the VM creation/deletion

Read cluster runtime status

Read Cluster Status

Read NSX Management nodes global configuration.

Update NSX Management nodes global configuration

NodeMode

Update the async_replicator service properties

Read auth service properties

Restart the auth service

Stop the auth service

Start the auth service

Update auth service properties

Read auth service status

Get information about all tasks

Get information about the specified task

Get the response of a task

Delete deployment information.

Get deployment information.

Create or update deployment information.

Create or update deployment information.