Server Nodes API

Server Nodes API

The Server Nodes REST API manages nodes in a cluster.

Description

A Couchbase Server instance, known as server node, is a physical or virtual machine running Couchbase Server. Each node is as a member of a cluster.

Table 1. Server node endpoints
HTTP method URI path Description Admin Role
GET /pools/nodes Retrieves information about nodes in a cluster. Full, Cluster
POST /controller/setRecoveryType Sets the recovery type to be performed for a node. Options are delta or full. Full, Cluster
POST /controller/failOver Fails over nodes. Full, Cluster
POST /controller/startGracefulFailover Sets graceful failover for a specific server node. The server node is specified with the otpNode=[node_name] parameter. Full, Cluster
POST /settings/web Sets user names and passwords. Full
POST /pools/default memoryQuota The memoryQuota parameter sets the memory quota. Full, Cluster
POST /nodes/self/controller/settings Sets the path for index files. Full, Cluster
GET /pools/default/buckets/default/ \ nodes/[host]:[port]/stats Retrieves statistics for a node. Full, Cluster