Update a 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.

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

Update a bucket’s retention period in the InfluxDB UI

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

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

Authentication credentials

The examples below assume your InfluxDB host, organization, and token are provided by the active influx CLI configuration. If you do not have a CLI configuration set up, use the appropriate flags to provide these required credentials.

Update the name of a bucket
  1. # Syntax
  2. influx bucket update -i <bucket-id> -n <new-bucket-name>
  4. # Example
  5. 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)

The minimum retention period is one hour.

  1. # Syntax
  2. influx bucket update -i <bucket-id> -r <retention period with units>
  4. # Example
  5. influx bucket update -i 034ad714fdd6f000 -r 1209600000000000ns