Documentation

Create a bucket

Use the InfluxDB user interface (UI), influx command line interface (CLI), or InfluxDB HTTP API to create a bucket.

By default, buckets have an implicit schema-type and a schema that conforms to your data. To require measurements to have specific columns and data types and prevent non-conforming write requests, create a bucket with the explicit schema-type.

There are two places you can create a bucket in the UI.

Create a bucket from the Load Data menu

  1. In the navigation menu on the left, select Load Data > Buckets.

  2. Click Create Bucket in the upper right.

  3. Enter a Name for the bucket.

  4. Select when to Delete Data:

    • Never to retain data forever.
    • Older than to choose a specific retention period.
  5. Click Create to create the bucket.

Create a bucket in the Data Explorer

  1. In the navigation menu on the left, select *Explore (Data Explorer).

  2. In the From panel in the Flux Builder, select + Create Bucket.

  3. Enter a Name for the bucket.

  4. Select when to Delete Data:

    • Never to retain data forever.
    • Older than to choose a specific retention period.
  5. 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
  • 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.

Create a bucket that enforces explicit schemas

A bucket with the explicit schema-type enforces measurement schemas that you define for the bucket and rejects writes that don’t conform to any of the schemas.

Use the influx CLI or InfluxDB HTTP API to create a bucket with the explicit schema-type.

Use the influx bucket create command and specify the --schema-type=explicit flag:

influx bucket create \
  --name my_schema_bucket \
  --schema-type explicit

Use the HTTP API /api/v2/buckets endpoint and set the schemaType property value to explicit in the request body–for example:

POST https://cloud2.influxdata.com/api/v2/buckets
{
  "orgID": "{INFLUX_ORG_ID}",
  "name": "my-explicit-bucket",
  "description": "My Explicit Bucket",
  "rp": "string",
  "retentionRules": [
    {
      "type": "expire",
      "everySeconds": 86400,
      "shardGroupDurationSeconds": 0
    }
  ],
  "schemaType": "explicit"
}

Next, see how to create an explicit bucket schema for a measurement.


Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.

InfluxDB Cloud Serverless powered by IOx