94 lines
2.1 KiB
Markdown
94 lines
2.1 KiB
Markdown
---
|
|
title: buckets() function
|
|
description: >
|
|
`buckets()` returns a list of buckets in the specified organization.
|
|
menu:
|
|
flux_v0_ref:
|
|
name: buckets
|
|
parent: influxdata/influxdb
|
|
identifier: influxdata/influxdb/buckets
|
|
weight: 201
|
|
flux/v0/tags: [metadata]
|
|
introduced: 0.16.0
|
|
---
|
|
|
|
<!------------------------------------------------------------------------------
|
|
|
|
IMPORTANT: This page was generated from comments in the Flux source code. Any
|
|
edits made directly to this page will be overwritten the next time the
|
|
documentation is generated.
|
|
|
|
To make updates to this documentation, update the function comments above the
|
|
function definition in the Flux source code:
|
|
|
|
https://github.com/influxdata/flux/blob/master/stdlib/influxdata/influxdb/influxdb.flux#L368-L379
|
|
|
|
Contributing to Flux: https://github.com/influxdata/flux#contributing
|
|
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
|
|
|
|
------------------------------------------------------------------------------->
|
|
|
|
`buckets()` returns a list of buckets in the specified organization.
|
|
|
|
|
|
|
|
##### Function type signature
|
|
|
|
```js
|
|
(
|
|
?host: string,
|
|
?org: string,
|
|
?orgID: string,
|
|
?token: string,
|
|
) => stream[{
|
|
retentionPolicy: string,
|
|
retentionPeriod: int,
|
|
organizationID: string,
|
|
name: string,
|
|
id: string,
|
|
}]
|
|
```
|
|
|
|
{{% caption %}}
|
|
For more information, see [Function type signatures](/flux/v0/function-type-signatures/).
|
|
{{% /caption %}}
|
|
|
|
## 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](/influxdb/cloud/reference/regions/)
|
|
or [InfluxDB OSS URLs](/influxdb/v2/reference/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
|
|
|
|
```js
|
|
buckets(org: "example-org", host: "http://localhost:8086", token: "mYSuP3rSecR37t0k3N")
|
|
|
|
```
|
|
|