Nodes and Clusters API
- reference
The Cluster REST API manages cluster operations.
Description
Cluster operations include managing server nodes, viewing cluster details, viewing cluster information, and managing auto-failover.
| HTTP method | URI path | Description | Admin Role |
|---|---|---|---|
GET |
/pools |
Retrieves cluster information. |
Full, Cluster |
GET |
/pools/default |
Retrieves cluster details. |
Full, Cluster |
POST |
/controller/addNode |
Adds nodes to clusters. |
Full, Cluster |
POST |
/node/controller/doJoinCluster |
Joins nodes into clusters. |
Full, Cluster |
POST |
/controller/ejectNode |
Removes nodes from clusters. |
Full, Cluster |
GET, POST, PUT, DELETE |
/pools/default/serverGroups |
Manages Server Group Awareness. |
Full |
POST |
/controller/rebalance |
Rebalances nodes in a cluster. |
Full, Cluster |
GET, POST |
/internalSettings |
Manages internal settings. Couchbase Server use only. |
Full, Cluster |
GET, POST |
/settings/maxParallelIndexers |
Manages parallel indexer configuration. Couchbase Server use only. |
Full, Cluster |
GET, POST |
/settings/autoFailover |
Manages automatic failover for clusters. |
Full, Cluster |
GET, POST |
/settings/autoFailover/resetCount |
Resets automatic failover for clusters. |
Full, Cluster |
GET, POST |
/settings/alerts |
Manages alerts for email notifications. |
Full, Cluster |
POST |
/settings/alerts/testEmail |
Creates test email for email notifications. |
Full, Cluster |
POST |
/settings/alerts/sendTestEmail |
Sends test email for email notifications. |
Full, Cluster |
GET, POST |
/settings/querySettings |
Manages cluster-level query settings. |
Full, Cluster |
GET, POST |
/settings/querySettings/curlWhitelist |
Manages cluster-level CURL access settings. |
Full, Cluster |