docs-v2/content/influxdb/v2/admin/buckets/create-bucket.md

5.2 KiB

title seotitle description menu weight aliases related
Create a bucket Create a bucket in InfluxDB Create buckets to store time series data in InfluxDB using the InfluxDB UI, `influx` CLI, or InfluxDB API.
influxdb_v2
name parent
Create a bucket Manage buckets
201
/influxdb/v2/organizations/buckets/create-bucket/
/influxdb/v2/reference/internals/data-retention/

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

{{% note %}}

Bucket limits

A single InfluxDB {{< current-version >}} 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. {{% /note %}}

{{< tabs-wrapper >}} {{% tabs %}} InfluxDB UI influx CLI InfluxDB API {{% /tabs %}}

{{% tab-content %}}

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 Data (Load Data) > Buckets.

    {{< nav-icon "data" >}}

  2. Click {{< icon "plus" >}} Create Bucket in the upper right.

  3. Enter a Name for the bucket (see Bucket naming restrictions).

  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).

    {{< nav-icon "data-explorer" >}}

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

  3. Enter a Name for the bucket (see Bucket naming restrictions).

  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.

{{% /tab-content %}}

{{% tab-content %}}

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)

    {{% note %}} The minimum retention period is one hour. {{% /note %}}

# 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

{{% /tab-content %}}

{{% tab-content %}}

To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint:

{{< api-endpoint method="post" endpoint="https://localhost:8086/api/v2/buckets" api-ref="/influxdb/v2/api/#operation/PostBuckets" >}}

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:
    {{< req type="key" >}}
    • {{< req "*" >}} name: Bucket name (see Bucket naming restrictions)
    • {{< req "*" >}} 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 {{< current-version >}} instance (see InfluxDB URLs).

{{% get-shared-text "api/v2.0/buckets/oss/create.sh" %}}

For information about InfluxDB API options and response codes, see InfluxDB API Buckets documentation.

{{% /tab-content %}}

{{< /tabs-wrapper >}}

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 (")