Interface IBucketsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IBucketsService : IApiAccessor

Methods

DeleteBucketsID(String, String)

Delete a bucket

Declaration

void DeleteBucketsID(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDAsync(String, String, CancellationToken)

Delete a bucket

Declaration

System.Threading.Tasks.Task DeleteBucketsIDAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDLabelsID(String, String, String)

Delete a label from a bucket

Declaration

void DeleteBucketsIDLabelsID(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

System.Threading.Tasks.Task DeleteBucketsIDLabelsIDAsync(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDLabelsIDAsyncWithHttpInfo(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a bucket

Declaration

ApiResponse<object> DeleteBucketsIDLabelsIDWithHttpInfo(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDMembersID(String, String, String)

Remove a member from a bucket

Declaration

void DeleteBucketsIDMembersID(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

System.Threading.Tasks.Task DeleteBucketsIDMembersIDAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDMembersIDAsyncWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a bucket

Declaration

ApiResponse<object> DeleteBucketsIDMembersIDWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDOwnersID(String, String, String)

Remove an owner from a bucket

Declaration

void DeleteBucketsIDOwnersID(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

System.Threading.Tasks.Task DeleteBucketsIDOwnersIDAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDOwnersIDAsyncWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a bucket

Declaration

ApiResponse<object> DeleteBucketsIDOwnersIDWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteBucketsIDWithHttpInfo(String, String)

Delete a bucket

Declaration

ApiResponse<object> DeleteBucketsIDWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBuckets(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

Buckets GetBuckets(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)

Returns

Type	Description
Buckets	Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsAsync(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

System.Threading.Tasks.Task<Buckets> GetBucketsAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Buckets>	Task of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

System.Threading.Tasks.Task<ApiResponse<Buckets>> GetBucketsAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Buckets>>	Task of ApiResponse (Buckets)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsID(String, String)

Retrieve a bucket

Declaration

Bucket GetBucketsID(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDAsync(String, String, CancellationToken)

Retrieve a bucket

Declaration

System.Threading.Tasks.Task<Bucket> GetBucketsIDAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Bucket>	Task of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<Bucket>> GetBucketsIDAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Bucket>>	Task of ApiResponse (Bucket)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDLabels(String, String)

List all labels for a bucket

Declaration

LabelsResponse GetBucketsIDLabels(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
LabelsResponse	LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDLabelsAsync(String, String, CancellationToken)

List all labels for a bucket

Declaration

System.Threading.Tasks.Task<LabelsResponse> GetBucketsIDLabelsAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<LabelsResponse>	Task of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetBucketsIDLabelsAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>>	Task of ApiResponse (LabelsResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDLabelsWithHttpInfo(String, String)

List all labels for a bucket

Declaration

ApiResponse<LabelsResponse> GetBucketsIDLabelsWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>	ApiResponse of LabelsResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDMembers(String, String)

List all users with member privileges for a bucket

Declaration

ResourceMembers GetBucketsIDMembers(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceMembers	ResourceMembers

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDMembersAsync(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

System.Threading.Tasks.Task<ResourceMembers> GetBucketsIDMembersAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ResourceMembers>	Task of ResourceMembers

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetBucketsIDMembersAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>>	Task of ApiResponse (ResourceMembers)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDMembersWithHttpInfo(String, String)

List all users with member privileges for a bucket

Declaration

ApiResponse<ResourceMembers> GetBucketsIDMembersWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>	ApiResponse of ResourceMembers

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDOwners(String, String)

List all owners of a bucket

Declaration

ResourceOwners GetBucketsIDOwners(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceOwners	ResourceOwners

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDOwnersAsync(String, String, CancellationToken)

List all owners of a bucket

Declaration

System.Threading.Tasks.Task<ResourceOwners> GetBucketsIDOwnersAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ResourceOwners>	Task of ResourceOwners

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all owners of a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetBucketsIDOwnersAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>>	Task of ApiResponse (ResourceOwners)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDOwnersWithHttpInfo(String, String)

List all owners of a bucket

Declaration

ApiResponse<ResourceOwners> GetBucketsIDOwnersWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>	ApiResponse of ResourceOwners

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsIDWithHttpInfo(String, String)

Retrieve a bucket

Declaration

ApiResponse<Bucket> GetBucketsIDWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Bucket>	ApiResponse of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetBucketsWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

ApiResponse<Buckets> GetBucketsWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Buckets>	ApiResponse of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBuckets(String, String, String)

Get buckets in a source

Declaration

Buckets GetSourcesIDBuckets(string sourceID, string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
Buckets	Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsAsync(String, String, String, CancellationToken)

Get buckets in a source

Declaration

System.Threading.Tasks.Task<Buckets> GetSourcesIDBucketsAsync(string sourceID, string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Buckets>	Task of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsAsyncWithHttpInfo(String, String, String, CancellationToken)

Get buckets in a source

Declaration

System.Threading.Tasks.Task<ApiResponse<Buckets>> GetSourcesIDBucketsAsyncWithHttpInfo(string sourceID, string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Buckets>>	Task of ApiResponse (Buckets)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsWithHttpInfo(String, String, String)

Get buckets in a source

Declaration

ApiResponse<Buckets> GetSourcesIDBucketsWithHttpInfo(string sourceID, string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Buckets>	ApiResponse of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchBucketsID(String, PatchBucketRequest, String)

Update a bucket

Declaration

Bucket PatchBucketsID(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchBucketsIDAsync(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

System.Threading.Tasks.Task<Bucket> PatchBucketsIDAsync(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Bucket>	Task of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchBucketsIDAsyncWithHttpInfo(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<Bucket>> PatchBucketsIDAsyncWithHttpInfo(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Bucket>>	Task of ApiResponse (Bucket)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchBucketsIDWithHttpInfo(String, PatchBucketRequest, String)

Update a bucket

Declaration

ApiResponse<Bucket> PatchBucketsIDWithHttpInfo(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Bucket>	ApiResponse of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBuckets(PostBucketRequest, String)

Create a bucket

Declaration

Bucket PostBuckets(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsAsync(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

System.Threading.Tasks.Task<Bucket> PostBucketsAsync(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Bucket>	Task of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsAsyncWithHttpInfo(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<Bucket>> PostBucketsAsyncWithHttpInfo(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Bucket>>	Task of ApiResponse (Bucket)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDLabels(String, LabelMapping, String)

Add a label to a bucket

Declaration

LabelResponse PostBucketsIDLabels(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
LabelResponse	LabelResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

System.Threading.Tasks.Task<LabelResponse> PostBucketsIDLabelsAsync(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<LabelResponse>	Task of LabelResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostBucketsIDLabelsAsyncWithHttpInfo(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>>	Task of ApiResponse (LabelResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a bucket

Declaration

ApiResponse<LabelResponse> PostBucketsIDLabelsWithHttpInfo(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>	ApiResponse of LabelResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

ResourceMember PostBucketsIDMembers(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceMember	ResourceMember

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

System.Threading.Tasks.Task<ResourceMember> PostBucketsIDMembersAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ResourceMember>	Task of ResourceMember

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostBucketsIDMembersAsyncWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>>	Task of ApiResponse (ResourceMember)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

ApiResponse<ResourceMember> PostBucketsIDMembersWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>	ApiResponse of ResourceMember

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

ResourceOwner PostBucketsIDOwners(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceOwner	ResourceOwner

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

System.Threading.Tasks.Task<ResourceOwner> PostBucketsIDOwnersAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ResourceOwner>	Task of ResourceOwner

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostBucketsIDOwnersAsyncWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>>	Task of ApiResponse (ResourceOwner)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

ApiResponse<ResourceOwner> PostBucketsIDOwnersWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>	ApiResponse of ResourceOwner

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostBucketsWithHttpInfo(PostBucketRequest, String)

Create a bucket

Declaration

ApiResponse<Bucket> PostBucketsWithHttpInfo(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Bucket>	ApiResponse of Bucket

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call