| 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).
|
POST /api/v1/batch
|
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
|
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 address
Returns the configured cluster virtual IP address or null if not configured.
|
GET /api/v1/cluster/api-virtual-ip
|
Clear cluster virtual IP address
Clears the cluster virtual IP address.
|
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip
|
Set cluster virtual IP address
Sets the cluster virtual IP address. Note, all nodes in the management
cluster must be in the same subnet. If not, a 409 CONFLICT status is
returned.
|
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.
Deprecated. Use POST /cluster?action=join_cluster to join a node to 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.
Deprecated. Use POST /cluster/?action=remove_node
to detach a node from cluster. The controller is removed with the node.
|
DELETE /api/v1/cluster/nodes/<node-id>
(Deprecated)
|
Read Cluster Node Configuration
Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.
|
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).
|
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>
|
Read the NSX Manager/Controller's Network Interface Statistics
On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.
|
GET /api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>/stats
|
Synchronizes the repository data between nsx managers.
Returns the synchronization status for the manager represented by given .
|
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 /api/v1/configs/management
|
Update NSX Management nodes global configuration
Modifies the NSX Management nodes global configuration.
|
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.
|
POST /api/v1/configs/node/mode
|
Read the NSX Manager's Network Interface Statistics
On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.
This api is deprecated as part of FN+TN unification. Please use
/transport-nodes//network/interfaces//stats to
read network interface statistics with contraint FN is converted to TN.
|
GET /api/v1/fabric/nodes/<node-id>/network/interfaces/<interface-id>/stats
(Deprecated)
|
Read Central Config properties
|
GET /api/v1/node/central-config
GET /api/v1/transport-nodes/<transport-node-id>/node/central-config
GET /api/v1/cluster/<cluster-node-id>/node/central-config
|
Update Central Config properties
|
PUT /api/v1/node/central-config
PUT /api/v1/transport-nodes/<transport-node-id>/node/central-config
PUT /api/v1/cluster/<cluster-node-id>/node/central-config
|
Current configuration for this node
|
GET /api/v1/node/configuration
GET /api/v1/transport-nodes/<transport-node-id>/node/configuration
GET /api/v1/cluster/<cluster-node-id>/node/configuration
|
Gets the enable status for Mandatory Access Control
|
GET /api/v1/node/hardening-policy/mandatory-access-control
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
|
Enable or disable Mandatory Access Control
|
PUT /api/v1/node/hardening-policy/mandatory-access-control
PUT /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
PUT /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control
|
Get the report for Mandatory Access Control
|
GET /api/v1/node/hardening-policy/mandatory-access-control/report
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control/report
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control/report
|
Delete management plane configuration for this node
Delete the management plane configuration for this node.
|
DELETE /api/v1/node/management-plane
DELETE /api/v1/transport-nodes/<transport-node-id>/node/management-plane
DELETE /api/v1/cluster/<cluster-node-id>/node/management-plane
|
Get management plane configuration for this node
Retrieve the management plane configuration for this node to identify the Manager node with which the controller service is communicating.
|
GET /api/v1/node/management-plane
(Experimental)
GET /api/v1/transport-nodes/<transport-node-id>/node/management-plane
(Experimental)
GET /api/v1/cluster/<cluster-node-id>/node/management-plane
(Experimental)
|
Update management plane configuration for this node
Update the management plane configuration for this node.
|
PUT /api/v1/node/management-plane
(Experimental)
PUT /api/v1/transport-nodes/<transport-node-id>/node/management-plane
(Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/management-plane
(Experimental)
|
NodeMode
Returns current Node Mode.
|
GET /api/v1/node/mode
GET /api/v1/transport-nodes/<transport-node-id>/node/mode
GET /api/v1/cluster/<cluster-node-id>/node/mode
|
Delete RabbitMQ management port
|
DELETE /api/v1/node/rabbitmq-management-port
DELETE /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
DELETE /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
|
Check if RabbitMQ management port is enabled or not
Returns status as true if RabbitMQ management port is enabled else false
|
GET /api/v1/node/rabbitmq-management-port
GET /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
GET /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
|
Set RabbitMQ management port
|
POST /api/v1/node/rabbitmq-management-port
POST /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
POST /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port
|
Read the Async Replicator service properties
|
GET /api/v1/node/services/async_replicator
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator
|
Restart, start or stop the Async Replicator service
|
POST /api/v1/node/services/async_replicator?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/async_replicator?action=restart|start|stop
|
Read the Async Replicator service status
|
GET /api/v1/node/services/async_replicator/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator/status
|
Read cluster boot manager service properties
|
GET /api/v1/node/services/cluster_manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager
|
Restart, start or stop the cluster boot manager service
|
POST /api/v1/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager?action=start|stop|restart
|
Read cluster boot manager service status
|
GET /api/v1/node/services/cluster_manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager/status
|
Read cm inventory service properties
|
GET /api/v1/node/services/cm-inventory
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cm-inventory
GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory
|
Restart, start or stop the manager service
|
POST /api/v1/node/services/cm-inventory?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/cm-inventory?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory?action=start|stop|restart
|
Read manager service status
|
GET /api/v1/node/services/cm-inventory/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cm-inventory/status
GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory/status
|
Read controller service properties
|
GET /api/v1/node/services/controller
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller
GET /api/v1/cluster/<cluster-node-id>/node/services/controller
|
Restart, start or stop the controller service
|
POST /api/v1/node/services/controller?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/controller?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/controller?action=restart|start|stop
|
Read controller server certificate properties
|
GET /api/v1/node/services/controller/controller-certificate
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller/controller-certificate
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/controller-certificate
|
Get the status (Enabled/Disabled) of controller profiler
|
GET /api/v1/node/services/controller/profiler
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller/profiler
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler
|
Enable or disable controller profiler
|
PUT /api/v1/node/services/controller/profiler
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/controller/profiler
PUT /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler
|
Read controller service status
|
GET /api/v1/node/services/controller/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller/status
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/status
|
Update NSX Edge Datapath service properties
|
PUT /api/v1/node/services/dataplane
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane
|
Update NSX Edge DHCP service properties
|
PUT /api/v1/node/services/dhcp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp
PUT /api/v1/cluster/<cluster-node-id>/node/services/dhcp
|
Read NSX Edge Dispatcher service properties
|
GET /api/v1/node/services/dispatcher
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher
GET /api/v1/cluster/<cluster-node-id>/node/services/dispatcher
|
Restart, start or stop the NSX Edge Dispatcher service
|
POST /api/v1/node/services/dispatcher?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/dispatcher?action=restart|start|stop
|
Read NSX Edge Dispatcher service status
|
GET /api/v1/node/services/dispatcher/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher/status
GET /api/v1/cluster/<cluster-node-id>/node/services/dispatcher/status
|
Read Druid service properties
|
GET /api/v1/node/services/druid
GET /api/v1/transport-nodes/<transport-node-id>/node/services/druid
GET /api/v1/cluster/<cluster-node-id>/node/services/druid
|
Restart, start or stop the Druid service
|
POST /api/v1/node/services/druid?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/druid?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/druid?action=restart|start|stop
|
Read Druid service status
|
GET /api/v1/node/services/druid/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/druid/status
GET /api/v1/cluster/<cluster-node-id>/node/services/druid/status
|
Read http service properties
This API is deprecated. Read the configuration of the
http service by calling the GET /api/v1/cluster/api-service API.
|
GET /api/v1/node/services/http
(Deprecated)
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http
(Deprecated)
GET /api/v1/cluster/<cluster-node-id>/node/services/http
(Deprecated)
|
Update http service certificate
Applies a security certificate to the http service. In the POST request,
the CERTIFICATE_ID references a certificate created with the
/api/v1/trust-management APIs. 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/node/services/http?action=apply_certificate
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=apply_certificate
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=apply_certificate
|
Stop the http service
|
POST /api/v1/node/services/http?action=stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=stop
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=stop
|
Start the http service
|
POST /api/v1/node/services/http?action=start
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=start
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=start
|
Restart the http service
|
POST /api/v1/node/services/http?action=restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=restart
|
Update http service properties
This API is deprecated. Make changes to the http service
configuration by calling the PUT /api/v1/cluster/api-service API.
|
PUT /api/v1/node/services/http
(Deprecated)
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/http
(Deprecated)
PUT /api/v1/cluster/<cluster-node-id>/node/services/http
(Deprecated)
|
Read http service status
|
GET /api/v1/node/services/http/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http/status
GET /api/v1/cluster/<cluster-node-id>/node/services/http/status
|
Read the idps-reporting service properties
|
GET /api/v1/node/services/idps-reporting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/idps-reporting
GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting
|
Restart, start or stop the idps-reporting service
|
POST /api/v1/node/services/idps-reporting?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/idps-reporting?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting?action=restart|start|stop
|
Read the idps-reporting service status
|
GET /api/v1/node/services/idps-reporting/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/idps-reporting/status
GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting/status
|
Read NSX install-upgrade service properties
|
GET /api/v1/node/services/install-upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
|
Restart, start or stop the NSX install-upgrade service
|
POST /api/v1/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade?action=restart|start|stop
|
Update NSX install-upgrade service properties
|
PUT /api/v1/node/services/install-upgrade
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade
|
Read NSX install-upgrade service status
|
GET /api/v1/node/services/install-upgrade/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/status
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/status
|
Update UC state properties
|
PUT /api/v1/node/services/install-upgrade/uc-state
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/uc-state
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/uc-state
|
Update NSX Edge Ipsec VPN service properties
|
PUT /api/v1/node/services/ipsecvpn
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn
PUT /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn
|
Read Kafka service properties
|
GET /api/v1/node/services/kafka
GET /api/v1/transport-nodes/<transport-node-id>/node/services/kafka
GET /api/v1/cluster/<cluster-node-id>/node/services/kafka
|
Restart, start or stop the Kafka service
|
POST /api/v1/node/services/kafka?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/kafka?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/kafka?action=restart|start|stop
|
Read Kafka service status
|
GET /api/v1/node/services/kafka/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/kafka/status
GET /api/v1/cluster/<cluster-node-id>/node/services/kafka/status
|
Update NSX Edge NSXA service properties
|
PUT /api/v1/node/services/local-controller
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller
PUT /api/v1/cluster/<cluster-node-id>/node/services/local-controller
|
Read service properties
|
GET /api/v1/node/services/manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager
GET /api/v1/cluster/<cluster-node-id>/node/services/manager
|
Reset the logging levels to default values
|
POST /api/v1/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=reset-manager-logging-levels
|
Restart, start or stop the service
|
POST /api/v1/node/services/manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=start|stop|restart
|
Update service properties
|
PUT /api/v1/node/services/manager
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/manager
PUT /api/v1/cluster/<cluster-node-id>/node/services/manager
|
Read service status
|
GET /api/v1/node/services/manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/manager/status
|
Read Metadata-proxy service properties
|
GET /api/v1/node/services/metadata-proxy
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy
GET /api/v1/cluster/<cluster-node-id>/node/services/metadata-proxy
|
Read Metadata-proxy service status
|
GET /api/v1/node/services/metadata-proxy/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/metadata-proxy/status
|
Read Rabbit MQ service properties
|
GET /api/v1/node/services/mgmt-plane-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus
|
Restart, start or stop the Rabbit MQ service
|
POST /api/v1/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop
|
Read Rabbit MQ service status
|
GET /api/v1/node/services/mgmt-plane-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus/status
|
Read migration coordinator service properties
|
GET /api/v1/node/services/migration-coordinator
GET /api/v1/transport-nodes/<transport-node-id>/node/services/migration-coordinator
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator
|
Restart, start or stop the migration coordinator service
|
POST /api/v1/node/services/migration-coordinator?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/migration-coordinator?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator?action=start|stop|restart
|
Read migration coordinator service status
|
GET /api/v1/node/services/migration-coordinator/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/migration-coordinator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator/status
|
Read NSX node-stats service properties
|
GET /api/v1/node/services/node-stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-stats
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats
|
Restart, start or stop the NSX node-stats service
|
POST /api/v1/node/services/node-stats?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-stats?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/node-stats?action=restart|start|stop
|
Read NSX node-stats service status
|
GET /api/v1/node/services/node-stats/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-stats/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats/status
|
Read NsxConfig service properties
|
GET /api/v1/node/services/nsx-config
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-config
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-config
|
Restart, start or stop the NsxConfig service
|
POST /api/v1/node/services/nsx-config?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-config?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-config?action=restart|start|stop
|
Read NsxConfig service status
|
GET /api/v1/node/services/nsx-config/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-config/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-config/status
|
Read NSX Control Plane Agent service properties
|
GET /api/v1/node/services/nsx-control-plane-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent
|
Restart, start or stop the NSX Control Plane Agent service
|
POST /api/v1/node/services/nsx-control-plane-agent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop
|
Read NSX Control Plane Agent service status
|
GET /api/v1/node/services/nsx-control-plane-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent/status
|
Read NSX Message Bus service properties
|
GET /api/v1/node/services/nsx-message-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus
|
Restart, start or stop the NSX Message Bus service
|
POST /api/v1/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus?action=restart|start|stop
|
Read NSX Message Bus service status
|
GET /api/v1/node/services/nsx-message-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus/status
|
Read NSX OpsAgent service properties
|
GET /api/v1/node/services/nsx-opsagent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent
|
Restart, start or stop the NSX OpsAgent service
|
POST /api/v1/node/services/nsx-opsagent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent?action=restart|start|stop
|
Read NSX OpsAgent service status
|
GET /api/v1/node/services/nsx-opsagent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent/status
|
Read PaceServer service properties
|
GET /api/v1/node/services/pace-server
GET /api/v1/transport-nodes/<transport-node-id>/node/services/pace-server
GET /api/v1/cluster/<cluster-node-id>/node/services/pace-server
|
Restart, start or stop the PaceServer service
|
POST /api/v1/node/services/pace-server?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/pace-server?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/pace-server?action=restart|start|stop
|
Read PaceServer service status
|
GET /api/v1/node/services/pace-server/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/pace-server/status
GET /api/v1/cluster/<cluster-node-id>/node/services/pace-server/status
|
Read service properties
|
GET /api/v1/node/services/policy
GET /api/v1/transport-nodes/<transport-node-id>/node/services/policy
GET /api/v1/cluster/<cluster-node-id>/node/services/policy
|
Restart, start or stop the service
|
POST /api/v1/node/services/policy?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/policy?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/policy?action=start|stop|restart
|
Reset the logging levels to default values
|
POST /api/v1/node/services/policy?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/policy?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/policy?action=reset-manager-logging-levels
|
Update service properties
|
PUT /api/v1/node/services/policy
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/policy
PUT /api/v1/cluster/<cluster-node-id>/node/services/policy
|
Read service status
|
GET /api/v1/node/services/policy/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/policy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/policy/status
|
Read Postgres service properties
|
GET /api/v1/node/services/postgres
GET /api/v1/transport-nodes/<transport-node-id>/node/services/postgres
GET /api/v1/cluster/<cluster-node-id>/node/services/postgres
|
Restart, start or stop the Postgres service
|
POST /api/v1/node/services/postgres?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/postgres?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/postgres?action=restart|start|stop
|
Read Postgres service status
|
GET /api/v1/node/services/postgres/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/postgres/status
GET /api/v1/cluster/<cluster-node-id>/node/services/postgres/status
|
Read Processing service properties
|
GET /api/v1/node/services/processing
GET /api/v1/transport-nodes/<transport-node-id>/node/services/processing
GET /api/v1/cluster/<cluster-node-id>/node/services/processing
|
Restart, start or stop the Processing service
|
POST /api/v1/node/services/processing?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/processing?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/processing?action=restart|start|stop
|
Read Processing service status
|
GET /api/v1/node/services/processing/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/processing/status
GET /api/v1/cluster/<cluster-node-id>/node/services/processing/status
|
Read NSX Search service properties
|
GET /api/v1/node/services/search
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search
GET /api/v1/cluster/<cluster-node-id>/node/services/search
|
Restart, start or stop the NSX Search service
|
POST /api/v1/node/services/search?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/search?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/search?action=restart|start|stop
|
Read NSX Search service status
|
GET /api/v1/node/services/search/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search/status
GET /api/v1/cluster/<cluster-node-id>/node/services/search/status
|
Read Spark service properties
|
GET /api/v1/node/services/spark
GET /api/v1/transport-nodes/<transport-node-id>/node/services/spark
GET /api/v1/cluster/<cluster-node-id>/node/services/spark
|
Restart, start or stop the Spark service
|
POST /api/v1/node/services/spark?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/spark?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/spark?action=restart|start|stop
|
Read SparkJobScheduler service properties
|
GET /api/v1/node/services/spark-job-scheduler
GET /api/v1/transport-nodes/<transport-node-id>/node/services/spark-job-scheduler
GET /api/v1/cluster/<cluster-node-id>/node/services/spark-job-scheduler
|
Restart, start or stop the SparkJobScheduler service
|
POST /api/v1/node/services/spark-job-scheduler?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/spark-job-scheduler?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/spark-job-scheduler?action=restart|start|stop
|
Read SparkJobScheduler service status
|
GET /api/v1/node/services/spark-job-scheduler/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/spark-job-scheduler/status
GET /api/v1/cluster/<cluster-node-id>/node/services/spark-job-scheduler/status
|
Read Spark service status
|
GET /api/v1/node/services/spark/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/spark/status
GET /api/v1/cluster/<cluster-node-id>/node/services/spark/status
|
Read Telemetry service properties
|
GET /api/v1/node/services/telemetry
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry
|
Restart, start or stop Telemetry service
|
POST /api/v1/node/services/telemetry?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/telemetry?action=restart|start|stop
|
Read Telemetry service status
|
GET /api/v1/node/services/telemetry/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry/status
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry/status
|
Read ui service properties
|
GET /api/v1/node/services/ui-service
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service
|
Restart, Start and Stop the ui service
|
POST /api/v1/node/services/ui-service?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ui-service?action=restart|start|stop
|
Read ui service status
|
GET /api/v1/node/services/ui-service/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service/status
|
Read Zookeeper service properties
|
GET /api/v1/node/services/zookeeper
GET /api/v1/transport-nodes/<transport-node-id>/node/services/zookeeper
GET /api/v1/cluster/<cluster-node-id>/node/services/zookeeper
|
Restart, start or stop the Zookeeper service
|
POST /api/v1/node/services/zookeeper?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/zookeeper?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/zookeeper?action=restart|start|stop
|
Read Zookeeper service status
|
GET /api/v1/node/services/zookeeper/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/zookeeper/status
GET /api/v1/cluster/<cluster-node-id>/node/services/zookeeper/status
|
Get information about all tasks
|
GET /api/v1/tasks
|
Get information about the specified task
|
GET /api/v1/tasks/<task-id>
|
Get the response of a task
|
GET /api/v1/tasks/<task-id>/response
|