Update Bucket with InfluxDB Cloud API

Pipedream makes it easy to connect APIs for InfluxDB Cloud and 2,500+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Update Bucket with the InfluxDB Cloud API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Update Bucket with the InfluxDB Cloud API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Update Bucket action
1. Connect your InfluxDB Cloud account
2. Select a Bucket ID
3. Optional- Configure Name
4. Optional- Configure Description
5. Optional- Configure Every Seconds
6. Optional- Configure Shard Group Duration Seconds
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Update Bucket with InfluxDB Cloud API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + InfluxDB Cloud

Try it

Update Bucket with InfluxDB Cloud API on New Submission from Typeform API

Typeform + InfluxDB Cloud

Try it

Update Bucket with InfluxDB Cloud API on New Submission (Instant) from Jotform API

Jotform + InfluxDB Cloud

Try it

Update Bucket with InfluxDB Cloud API on New Scheduled Tasks from Pipedream API

Pipedream + InfluxDB Cloud

Try it

Update Bucket with InfluxDB Cloud API on New Download Counts from npm API

npm + InfluxDB Cloud

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Update Bucket on InfluxDB Cloud

Description:Updates an existing bucket in InfluxDB Cloud. [See the documentation](https://docs.influxdata.com/influxdb3/cloud-serverless/api/v2/#operation/PatchBucketsID)

Version:0.0.1

Key:influxdb_cloud-update-bucket

View on GitHub

Code#

import influxDbCloud from "../../influxdb_cloud.app.mjs";

export default {
  key: "influxdb_cloud-update-bucket",
  name: "Update Bucket",
  description: "Updates an existing bucket in InfluxDB Cloud. [See the documentation](https://docs.influxdata.com/influxdb3/cloud-serverless/api/v2/#operation/PatchBucketsID)",
  version: "0.0.1",
  type: "action",
  props: {
    influxDbCloud,
    bucketId: {
      propDefinition: [
        influxDbCloud,
        "bucketId",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the bucket. Must contain two or more characters. Cannot start with an underscore (_). Cannot contain a double quote (\"). Note: System buckets cannot be renamed.",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "A description of the bucket",
      optional: true,
    },
    everySeconds: {
      type: "integer",
      label: "Every Seconds",
      description: "The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.",
      default: 2592000,
      optional: true,
    },
    shardGroupDurationSeconds: {
      type: "integer",
      label: "Shard Group Duration Seconds",
      description: "The shard group duration. The duration or interval (in seconds) that each shard group covers.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.influxDbCloud.updateBucket({
      $,
      bucketId: this.bucketId,
      data: {
        name: this.name,
        description: this.description,
        retentionRules: [
          {
            everySeconds: this.everySeconds,
            shardGroupDurationSeconds: this.shardGroupDurationSeconds,
            type: "expire",
          },
        ],
      },
    });
    $.export("$summary", `Successfully updated bucket with ID: ${response.id}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
InfluxDB Cloud	`influxDbCloud`	`app`	This component uses the InfluxDB Cloud app.
Bucket ID	`bucketId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	Name of the bucket. Must contain two or more characters. Cannot start with an underscore (_). Cannot contain a double quote ("). Note: System buckets cannot be renamed.
Description	`description`	`string`	A description of the bucket
Every Seconds	`everySeconds`	`integer`	The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.
Shard Group Duration Seconds	`shardGroupDurationSeconds`	`integer`	The shard group duration. The duration or interval (in seconds) that each shard group covers.