InfluxDB 2.0 JavaScript client
Home > @influxdata/influxdb-client-apis > GetBucketsRequest
Signature:
interface GetBucketsRequest
| Property | Modifiers | Type | Description |
|---|---|---|---|
| after? | string | (Optional) Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. |
|
| id? | string | (Optional) Bucket ID. Only returns the bucket with this ID. | |
| limit? | number | (Optional) Limits the number of records returned. Default is 20. |
|
| name? | string | (Optional) Bucket name. Only returns buckets with this specific name. | |
| offset? | number | (Optional) The offset for pagination. The number of records to skip. | |
| org? | string | <p>(Optional) Organization name. The name of the organization.</p><p>#### InfluxDB Cloud</p><p>- Doesn’t use org or orgID. - Creates a bucket in the organization associated with the authorization (API token).</p><p>#### InfluxDB OSS</p><p>- Accepts either org or orgID. - InfluxDB creates the bucket within this organization.</p> |
|
| orgID? | string | <p>(Optional) Organization ID. The organization ID.</p><p>#### InfluxDB Cloud</p><p>- Doesn’t use org or orgID. - Creates a bucket in the organization associated with the authorization (API token).</p><p>#### InfluxDB OSS</p><p>- Accepts either org or orgID. - InfluxDB creates the bucket within this organization.</p> |