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.



Organization name. Default is the current organization.

org and orgID are mutually exclusive.


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

org and orgID are mutually exclusive.


URL of the InfluxDB instance.

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


InfluxDB API token.

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


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!

Introducing InfluxDB 3.0

The new core of InfluxDB built with Rust and Apache Arrow. Available today in InfluxDB Cloud Dedicated.

Learn more

State of the InfluxDB Cloud Serverless documentation

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.