Bucket API Specification Reference
The Bucket API allows users to create, modify, and delete buckets.
Before starting to record data, a user must first create a bucket and specify settings such as:
- Maximum block size
- Maximum number of records
- Quota type
- Quota size
For more information about buckets, read the Bucket Guide.
Get Information about a Bucket​
The method returns the current settings, stats, and entry list of the bucket in JSON format.
If authentication is enabled, the method needs a valid API token.
Check if a Bucket Exists​
If authentication is enabled, the method needs a valid API token.
Create a New Bucket​
To create a bucket, the request should contain a JSON document with some parameters or empty body. The new bucket uses default values if some parameters are empty.
If authentication is enabled, the method needs a valid API token with full access.
Changes:
- v1.12: HARD quota type was introduced.
Change Settings of a Bucket​
To update settings of a bucket, the request should have a JSON document with all the settings.
If authentication is enabled, the method needs a valid API token with full access.
Changes:
- v1.12: HARD quota type was introduced.
Rename a Bucket​
To rename a bucket, the request should have a JSON document with the new name.
If authentication is enabled, the method needs a valid API token with full access.
Changes:
- v1.12: the endpoint was introduced.
Remove a Bucket​
Remove a bucket with all its entries and stored data.
If authentication is enabled, the method needs a valid API token with full access.
This operation is irreversible. All data in the bucket will be lost.