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 Admin Role

    GET

    /pools/default/buckets

    Retrieves all bucket and bucket operations information from a cluster.

    Full, Cluster, Bucket*

    GET

    /pools/default/buckets/[bucket_name]

    Retrieves information for a single bucket associated with a cluster.

    Full, Cluster, Bucket*, Bucket A

    GET

    /pools/default/buckets/[bucket_name]/stats

    Retrieves bucket statistics for a specific bucket.

    Full, Cluster, Bucket*, Bucket A

    POST

    /pools/default/buckets

    Creates a new Couchbase bucket.

    Full, Cluster

    DELETE

    /pools/default/buckets/[bucket_name]

    Deletes a specific bucket.

    Full, Cluster

    POST

    /pools/default/buckets/[bucket_name]/controller/doFlush

    Flushes a specific bucket.

    Full, Cluster, Bucket*, Bucket A

    "Bucket A" represents a bucket administrator for a single bucket, and Bucket* a bucket administrator with privileges for all buckets in the cluster.