Class BucketsAPI

Buckets API

Index

Constructors

Methods

deleteBucketsID deleteBucketsIDLabelsID deleteBucketsIDMembersID deleteBucketsIDOwnersID getBuckets getBucketsID getBucketsIDLabels getBucketsIDMembers getBucketsIDOwners patchBucketsID postBuckets postBucketsIDLabels postBucketsIDMembers postBucketsIDOwners

Constructors

constructor

new BucketsAPI(influxDB: InfluxDB): BucketsAPI
Creates BucketsAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns BucketsAPI
- Defined in apis/src/generated/BucketsAPI.ts:153

Methods

deleteBucketsID

deleteBucketsID(
request: DeleteBucketsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsID
Parameters
- request: DeleteBucketsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:245

deleteBucketsIDLabelsID

deleteBucketsIDLabelsID(
request: DeleteBucketsIDLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a label from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDLabelsID
Parameters
- request: DeleteBucketsIDLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:300

deleteBucketsIDMembersID

deleteBucketsIDMembersID(
request: DeleteBucketsIDMembersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove a member from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDMembersID
Parameters
- request: DeleteBucketsIDMembersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:355

deleteBucketsIDOwnersID

deleteBucketsIDOwnersID(
request: DeleteBucketsIDOwnersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove an owner from a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteBucketsIDOwnersID
Parameters
- request: DeleteBucketsIDOwnersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:410

getBuckets

getBuckets(
request?: GetBucketsRequest,
requestOptions?: RequestOptions,
): Promise<Buckets>
List buckets. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBuckets
Parameters
- Optionalrequest: GetBucketsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Buckets>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:163

getBucketsID

getBucketsID(
request: GetBucketsIDRequest,
requestOptions?: RequestOptions,
): Promise<Bucket>
Retrieve a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsID
Parameters
- request: GetBucketsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Bucket>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:208

getBucketsIDLabels

getBucketsIDLabels(
request: GetBucketsIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels for a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDLabels
Parameters
- request: GetBucketsIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:263

getBucketsIDMembers

getBucketsIDMembers(
request: GetBucketsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMembers>
List all users with member privileges for a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDMembers
Parameters
- request: GetBucketsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMembers>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:318

getBucketsIDOwners

getBucketsIDOwners(
request: GetBucketsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwners>
List all owners of a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetBucketsIDOwners
Parameters
- request: GetBucketsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwners>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:373

patchBucketsID

patchBucketsID(
request: PatchBucketsIDRequest,
requestOptions?: RequestOptions,
): Promise<Bucket>
Update a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchBucketsID
Parameters
- request: PatchBucketsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Bucket>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:226

postBuckets

postBuckets(
request: PostBucketsRequest,
requestOptions?: RequestOptions,
): Promise<Bucket>
Create a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBuckets
Parameters
- request: PostBucketsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Bucket>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:189

postBucketsIDLabels

postBucketsIDLabels(
request: PostBucketsIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Add a label to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDLabels
Parameters
- request: PostBucketsIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:281

postBucketsIDMembers

postBucketsIDMembers(
request: PostBucketsIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMember>
Add a member to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDMembers
Parameters
- request: PostBucketsIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMember>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:336

postBucketsIDOwners

postBucketsIDOwners(
request: PostBucketsIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwner>
Add an owner to a bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostBucketsIDOwners
Parameters
- request: PostBucketsIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwner>
promise of response
- Defined in apis/src/generated/BucketsAPI.ts:391

Class BucketsAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BucketsAPI

Methods

deleteBucketsID

Parameters

Returns Promise<void>

deleteBucketsIDLabelsID

Parameters

Returns Promise<void>

deleteBucketsIDMembersID

Parameters

Returns Promise<void>

deleteBucketsIDOwnersID

Parameters

Returns Promise<void>

getBuckets

Parameters

Returns Promise<Buckets>

getBucketsID

Parameters

Returns Promise<Bucket>

getBucketsIDLabels

Parameters

Returns Promise<LabelsResponse>

getBucketsIDMembers

Parameters

Returns Promise<ResourceMembers>

getBucketsIDOwners

Parameters

Returns Promise<ResourceOwners>

patchBucketsID

Parameters

Returns Promise<Bucket>

postBuckets

Parameters

Returns Promise<Bucket>

postBucketsIDLabels

Parameters

Returns Promise<LabelResponse>

postBucketsIDMembers

Parameters

Returns Promise<ResourceMember>

postBucketsIDOwners

Parameters

Returns Promise<ResourceOwner>

Settings

On This Page