Documentation

buckets() function

buckets() returns a list of buckets in the specified organization.

Function type signature
(
    ?host: string,
    ?org: string,
    ?orgID: string,
    ?token: string,
) => stream[{
    retentionPolicy: string,
    retentionPeriod: int,
    organizationID: string,
    name: string,
    id: string,
}]

For more information, see Function type signatures.

Parameters

org

Organization name. Default is the current organization.

org and orgID are mutually exclusive.

orgID

Organization ID. Default is the ID of the current organization.

org and orgID are mutually exclusive.

host

URL of the InfluxDB instance.

See InfluxDB Cloud regions or InfluxDB OSS URLs. host is required when org or orgID are specified.

token

InfluxDB API token.

token is required when host, org, or orgID` are specified.

Examples

List buckets in an InfluxDB organization

buckets(org: "example-org", host: "http://localhost:8086", token: "mYSuP3rSecR37t0k3N")

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

New in InfluxDB 3.4

Key enhancements in InfluxDB 3.4 and the InfluxDB 3 Explorer 1.2.

See the Blog Post

InfluxDB 3.4 is now available for both Core and Enterprise, which introduces offline token generation for use in automated deployments and configurable license type selection that lets you bypass the interactive license prompt. InfluxDB 3 Explorer 1.2 is also available, which includes InfluxDB cache management and other new features.

For more information, check out: