Create a bucket
Use the InfluxDB user interface (UI), the influx
command line interface (CLI),
or the InfluxDB API to create a bucket.
Bucket limits
A single InfluxDB 2.7 OSS instance supports approximately 20 buckets actively being written to or queried across all organizations depending on the use case. Any more than that can adversely affect performance.
There are two places you can create a bucket in the UI.
Create a bucket from the Load Data menu
In the navigation menu on the left, select Data (Load Data) > Buckets.
Click Create Bucket in the upper right.
Enter a Name for the bucket (see Bucket naming restrictions).
Select when to Delete Data:
- Never to retain data forever.
- Older than to choose a specific retention period.
Click Create to create the bucket.
Create a bucket in the Data Explorer
In the navigation menu on the left, select Explore (Data Explorer).
In the From panel in the Flux Builder, select
+ Create Bucket
.Enter a Name for the bucket (see Bucket naming restrictions).
Select when to Delete Data:
- Never to retain data forever.
- Older than to choose a specific retention period.
Click Create to create the bucket.
Use the influx bucket create
command
to create a new bucket.
Include the following flags with the command:
-n
,--name
: Bucket name (see Bucket naming restrictions)-o
,--org
or--org-id
: Organization name or ID-r
,--retention
: Bucket retention period (duration to keep data) in one of the following units:- nanoseconds (
ns
) - microseconds (
us
orµs
) - milliseconds (
ms
) - seconds (
s
) - minutes (
m
) - hours (
h
) - days (
d
) - weeks (
w
)
- nanoseconds (
The minimum retention period is one hour.
# Syntax
influx bucket create \
--name <bucket-name> \
--org <org-name> \
--retention <retention-period-duration>
# Example
influx bucket create \
--name my-bucket \
--org my-org \
--retention 72h
To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint:
POST https://localhost:8086/api/v2/buckets
Include the following in your request:
- Headers:
- Authorization:
Token
scheme with your InfluxDB API token - Content-type:
application/json
- Authorization:
- Request body: JSON object with the following fields:
* Required- * name: Bucket name (see Bucket naming restrictions)
- * orgID: InfluxDB organization ID
- description: Bucket description
- retentionRules: JSON array containing a single object
with the following fields:
- type: expire
- everySecond: Number of seconds to retain data (0 means forever)
- shardGroupDuration: Number of seconds to retain shard groups (0 means forever)
Example
The URL depends on the version and location of your InfluxDB 2.7 instance (see InfluxDB URLs).
INFLUX_TOKEN=YOUR_API_TOKEN
INFLUX_ORG_ID=YOUR_ORG_ID
curl --request POST \
"http://localhost:8086/api/v2/buckets" \
--header "Authorization: Token ${INFLUX_TOKEN}" \
--header "Content-type: application/json" \
--data '{
"orgID": "'"${INFLUX_ORG_ID}"'",
"name": "iot-center",
"retentionRules": [
{
"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
]
}'
For information about InfluxDB API options and response codes, see InfluxDB API Buckets documentation.
Bucket naming restrictions
Bucket names must adhere to the following naming restrictions:
- Must contain two or more characters
- Cannot start with an underscore (
_
) - Cannot contain a double quote (
"
)
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.