Create a bucket
Use the InfluxDB user interface (UI), influx
command line interface (CLI), or InfluxDB HTTP API
to create a bucket.
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 Load Data > Buckets.
- Click Create Bucket in the upper right.
- Enter a Name for the bucket.
- Select when to Delete Data:
- Never to retain data forever.
- Older than to choose a specific retention period.
- Click Create to create the bucket.
To create a bucket with the influx
CLI, use the influx bucket create
command
and specify values for the following flags:
-o
,--org
: Organization name-n
,--name
: Bucket name-r
,--retention
: Retention period duration
The following example creates a bucket with a retention period of 72 hours:
influx bucket create \
--name my-bucket \
--org {INFLUX_ORG} \
--retention 72h
To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint:
POST https://cloud2.influxdata.com/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
- 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)
The following example creates a bucket with a retention period of 86,400
seconds, or 24 hours:
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 reference documentation.
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.