influxdb-client-js

InfluxDB 2.0 JavaScript client

View the Project on GitHub influxdata/influxdb-client-js

Home > @influxdata/influxdb-client-apis > BucketsAPI

BucketsAPI class

Buckets API

Signature:

declare class BucketsAPI 

Constructors

Constructor Modifiers Description
(constructor)(influxDB)   Creates BucketsAPI

Methods

Method Modifiers Description
deleteBucketsID(request, requestOptions)   Delete a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsID
deleteBucketsIDLabelsID(request, requestOptions)   Delete a label from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDLabelsID
deleteBucketsIDMembersID(request, requestOptions)   Remove a member from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDMembersID
deleteBucketsIDOwnersID(request, requestOptions)   Remove an owner from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDOwnersID
getBuckets(request, requestOptions)   List buckets. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBuckets
getBucketsID(request, requestOptions)   Retrieve a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsID
getBucketsIDLabels(request, requestOptions)   List all labels for a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDLabels
getBucketsIDMembers(request, requestOptions)   List all users with member privileges for a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDMembers
getBucketsIDOwners(request, requestOptions)   List all owners of a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDOwners
patchBucketsID(request, requestOptions)   Update a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchBucketsID
postBuckets(request, requestOptions)   Create a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBuckets
postBucketsIDLabels(request, requestOptions)   Add a label to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDLabels
postBucketsIDMembers(request, requestOptions)   Add a member to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDMembers
postBucketsIDOwners(request, requestOptions)   Add an owner to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDOwners