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

2.7 KiB

title seotitle description menu weight aliases
Update a bucket Update a bucket in InfluxDB Update a bucket's name or retention period in InfluxDB using the InfluxDB UI or the influx CLI.
influxdb_v2
name parent
Update a bucket Manage buckets
202
/influxdb/v2/organizations/buckets/update-bucket/

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

Note that updating an bucket's name will affect any assets that reference the bucket by name, including the following:

  • Queries
  • Dashboards
  • Tasks
  • Telegraf configurations
  • Templates

If you change a bucket name, be sure to update the bucket in the above places as well.

Update a bucket's name in the InfluxDB UI

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

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

  2. Click Settings under the bucket you want to rename.

  3. Click Rename.

  4. Review the information in the window that appears and click I understand, let's rename my bucket.

  5. Update the bucket's name and click Change Bucket Name.

{{% note %}} For information about permitted bucket names, see bucket naming restrictions. {{% /note %}}

Update a bucket's retention period in the InfluxDB UI

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

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

  2. Click Settings next to the bucket you want to update.

  3. In the window that appears, edit the bucket's retention period.

  4. Click Save Changes.

Update a bucket using the influx CLI

Use the influx bucket update command to update a bucket. Updating a bucket requires the following:

  • The bucket ID (provided in the output of influx bucket list)
  • The name or ID of the organization the bucket belongs to.

{{< cli/influx-creds-note >}}

Update the name of a bucket

{{% note %}} For information about permitted bucket names, see bucket naming restrictions. {{% /note %}}

# Syntax
influx bucket update -i <bucket-id> -n <new-bucket-name>

# Example
influx bucket update -i 034ad714fdd6f000 -n my-new-bucket
Update a bucket's retention period

Valid retention period duration 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 update -i <bucket-id> -r <retention period with units>

# Example
influx bucket update -i 034ad714fdd6f000 -r 1209600000000000ns