Buckets API

Buckets API

The Buckets REST API creates, deletes, flushes, and retrieves information about buckets and bucket operations.

Description

The bucket management and configuration REST API endpoints provide a fine level of control over the individual buckets in the cluster, their configuration, and specific operations.

Table 1. Bucket endpoints
HTTP method URI path Description
GET /pools/default/buckets Retrieves all bucket and bucket operations information from a cluster.
GET /pools/default/buckets/default Retrieves information for a single bucket associated with a cluster.
GET /pools/default/buckets/[bucket_name]/stats Retrieves bucket statistics for a specific bucket.
POST /pools/default/buckets Creates a new Couchbase bucket.
DELETE /pools/default/buckets/[bucket_name] Deletes a specific bucket.
POST /pools/default/buckets/default/controller/doFlush Flushes a specific bucket.