Cluster API

Cluster API

The Cluster REST API manages cluster operations.

Description

Cluster operations include managing server nodes, viewing cluster details, viewing cluster information, and managing auto-failover.

Table 1. Cluster endpoints
HTTP method URI path Description
GET /pools Retrieves cluster information.
GET /pools/default Retrieves cluster details.
POST /controller/addNode Adds nodes to clusters.
POST /node/controller/doJoinCluster Joins nodes into clusters
POST /controller/ejectNodeentry Removes nodes from clusters.
GET, POST, PUT, DELETE /pools/default/serverGroups Manages rack zone awareness (server groups).
POST /controller/rebalance Rebalances nodes in a cluster.
GET, POST /internalSettings Manages internal settings. Couchbase Server use only.
GET, POST /settings/maxParallelIndexers Manages parallel indexer configuration. Couchbase Server use only.
GET, POST /settings/autoFailover Manages automatic failover for clusters.
GET, POST /settings/autoFailover/resetCount Resets automatic failover for clusters.
GET, POST /settings/alerts Manages alerts for email notifications.
POST /settings/alerts/testEmail Creates test email for email notifications.
POST /settings/alerts/sendTestEmail Sends test email for email notifications.