Interface ISecretsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ISecretsService : IApiAccessor

Methods

DeleteOrgsIDSecretsID(String, String, String)

Delete a secret from an organization

Declaration

void DeleteOrgsIDSecretsID(string orgID, string secretID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	secretID	The secret ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteOrgsIDSecretsIDAsync(String, String, String, CancellationToken)

Delete a secret from an organization

Declaration

System.Threading.Tasks.Task DeleteOrgsIDSecretsIDAsync(string orgID, string secretID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	secretID	The secret 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

DeleteOrgsIDSecretsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a secret from an organization

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteOrgsIDSecretsIDAsyncWithHttpInfo(string orgID, string secretID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	secretID	The secret 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

DeleteOrgsIDSecretsIDWithHttpInfo(String, String, String)

Delete a secret from an organization

Declaration

ApiResponse<object> DeleteOrgsIDSecretsIDWithHttpInfo(string orgID, string secretID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	secretID	The secret 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

GetOrgsIDSecrets(String, String)

List all secret keys for an organization

Declaration

SecretKeysResponse GetOrgsIDSecrets(string orgID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
SecretKeysResponse	SecretKeysResponse

Exceptions

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

GetOrgsIDSecretsAsync(String, String, CancellationToken)

List all secret keys for an organization

Declaration

System.Threading.Tasks.Task<SecretKeysResponse> GetOrgsIDSecretsAsync(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetOrgsIDSecretsAsyncWithHttpInfo(String, String, CancellationToken)

List all secret keys for an organization

Declaration

System.Threading.Tasks.Task<ApiResponse<SecretKeysResponse>> GetOrgsIDSecretsAsyncWithHttpInfo(string orgID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetOrgsIDSecretsWithHttpInfo(String, String)

List all secret keys for an organization

Declaration

ApiResponse<SecretKeysResponse> GetOrgsIDSecretsWithHttpInfo(string orgID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PatchOrgsIDSecrets(String, Dictionary<String, String>, String)

Update secrets in an organization

Declaration

void PatchOrgsIDSecrets(string orgID, Dictionary<string, string> requestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
Dictionary<System.String, System.String>	requestBody	Secret key value pairs to update/add
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

PatchOrgsIDSecretsAsync(String, Dictionary<String, String>, String, CancellationToken)

Update secrets in an organization

Declaration

System.Threading.Tasks.Task PatchOrgsIDSecretsAsync(string orgID, Dictionary<string, string> requestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
Dictionary<System.String, System.String>	requestBody	Secret key value pairs to update/add
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

PatchOrgsIDSecretsAsyncWithHttpInfo(String, Dictionary<String, String>, String, CancellationToken)

Update secrets in an organization

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> PatchOrgsIDSecretsAsyncWithHttpInfo(string orgID, Dictionary<string, string> requestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
Dictionary<System.String, System.String>	requestBody	Secret key value pairs to update/add
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

PatchOrgsIDSecretsWithHttpInfo(String, Dictionary<String, String>, String)

Update secrets in an organization

Declaration

ApiResponse<object> PatchOrgsIDSecretsWithHttpInfo(string orgID, Dictionary<string, string> requestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
Dictionary<System.String, System.String>	requestBody	Secret key value pairs to update/add
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

PostOrgsIDSecrets(String, SecretKeys, String)

Delete secrets from an organization

Declaration

void PostOrgsIDSecrets(string orgID, SecretKeys secretKeys, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
SecretKeys	secretKeys	Secret key to delete
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

PostOrgsIDSecretsAsync(String, SecretKeys, String, CancellationToken)

Delete secrets from an organization

Declaration

System.Threading.Tasks.Task PostOrgsIDSecretsAsync(string orgID, SecretKeys secretKeys, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
SecretKeys	secretKeys	Secret key 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

PostOrgsIDSecretsAsyncWithHttpInfo(String, SecretKeys, String, CancellationToken)

Delete secrets from an organization

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> PostOrgsIDSecretsAsyncWithHttpInfo(string orgID, SecretKeys secretKeys, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
SecretKeys	secretKeys	Secret key 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

PostOrgsIDSecretsWithHttpInfo(String, SecretKeys, String)

Delete secrets from an organization

Declaration

ApiResponse<object> PostOrgsIDSecretsWithHttpInfo(string orgID, SecretKeys secretKeys, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	orgID	The organization ID.
SecretKeys	secretKeys	Secret key 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