Cluster Management

Updated

Updated on Sep 9, 2026
Published on Sep 3, 2026

1 minute(s) read

Article summary

The MVX Cluster Management API provides a highly available and scalable MVX cluster management service.

Use the following APIs to configure cluster management settings from MVX:

Logging in to a cluster
https://<VX_MGMT_IP>/wsapis/common/v2.0.0/auth/login

Logging out of a cluster
https://<VX_MGMT_IP>/wsapis/common/v2.0.0/auth/logout

Create cluster
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/cluster/<CLUSTER_NAME>

Delete cluster
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/cluster/<CLUSTER_NAME>

Delete cluster on local host
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/cluster/self

Add a node to a cluster
https://<VX2_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/node/self

Remove a local node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/node/self

Remove a local node with force
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/node/self

Remove a remote node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/node/<REMOTE_NODE_NAME>

Enable broker role on a local node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/service/mvxbroker

Enable broker role on a remote node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/service/mvxbroker

Disable broker role on a local node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/service/mvxbroker

Disable broker role on a remote node
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/service/mvxbroker

List clusters
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/clusters

List nodes
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/nodes

List services
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/services

Read cluster configuration
https://<VX_MGMT_IP>/wsapis/v2.0.0/proxy/clustermgmt/v1/mvx/cluster/<CLUSTER_NAME>/config

:

Was this article helpful?