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,
}]

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: "https://cloud2.influxdata.com", token: "mYSuP3rSecR37t0k3N")