Buckets API

  • reference
March 16, 2025
+ 12
The Buckets REST API creates, deletes, flushes, and retrieves information about buckets and bucket operations.

APIs in this Section

The REST API allows buckets to be created, edited, flushed, and deleted. For a list of all methods and URIs covered in this section, see the table provided below.

HTTP Method URI Documented at

POST

/pools/default/buckets

Creating and Editing Buckets

POST

/pools/default/buckets/<bucketName>

Creating and Editing Buckets

GET

/pools/default/buckets

Getting Bucket Information

GET

/pools/default/buckets/<bucket-name>

Getting Bucket Information

POST

/pools/default/buckets/<bucket-name>/nodes

Listing Nodes by Bucket

GET

/pools/default/buckets/[bucket-name]/stats

Getting Bucket Statistics

GET

/pools/default/buckets/default

Getting Bucket Streaming URI

DELETE

/pools/default/buckets/[bucket-name]

Deleting Buckets

DELETE

/pools/default/buckets/[bucket-name]

Deleting Buckets

POST

/pools/default/buckets/[bucket-name]/controller/doFlush

Flushing Buckets

GET

/sampleBuckets

Managing Sample Buckets

POST

/sampleBuckets/install

Managing Sample Buckets