Class SecretsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

SecretsService

Implements

ISecretsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class SecretsService : object, ISecretsService, IApiAccessor

Constructors

SecretsService(Configuration)

Initializes a new instance of the SecretsService class using Configuration object

Declaration

public SecretsService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

SecretsService(String)

Initializes a new instance of the SecretsService class.

Declaration

public SecretsService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

DeleteOrgsIDSecretsID(String, String, String)

Delete a secret from an organization

Declaration

public 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

public 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

public 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

DeleteOrgsIDSecretsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a secret from an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDSecretsIDAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

DeleteOrgsIDSecretsIDWithIRestResponse(String, String, String)

Delete a secret from an organization

Declaration

public RestResponse DeleteOrgsIDSecretsIDWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

DeleteOrgsIDSecretsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a secret from an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> DeleteOrgsIDSecretsIDWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

DeleteOrgsIDSecretsIDWithRestRequest(String, String, String)

Delete a secret from an organization

Declaration

public RestRequest DeleteOrgsIDSecretsIDWithRestRequest(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
RestRequest	ApiResponse of Object(void)

Exceptions

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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

GetOrgsIDSecrets(String, String)

List all secret keys for an organization

Declaration

public 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

public 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

public 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

GetOrgsIDSecretsAsyncWithIRestResponse(String, String, CancellationToken)

List all secret keys for an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> GetOrgsIDSecretsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (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

public 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

GetOrgsIDSecretsWithIRestResponse(String, String)

List all secret keys for an organization

Declaration

public RestResponse GetOrgsIDSecretsWithIRestResponse(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
RestResponse	ApiResponse of SecretKeysResponse

Exceptions

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

GetOrgsIDSecretsWithIRestResponseAsync(String, String, CancellationToken)

List all secret keys for an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> GetOrgsIDSecretsWithIRestResponseAsync(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<RestResponse>	ApiResponse of SecretKeysResponse

Exceptions

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

GetOrgsIDSecretsWithRestRequest(String, String)

List all secret keys for an organization

Declaration

public RestRequest GetOrgsIDSecretsWithRestRequest(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
RestRequest	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

public 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

public 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

public 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

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

Update secrets in an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> PatchOrgsIDSecretsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

PatchOrgsIDSecretsWithIRestResponse(String, Dictionary<String, String>, String)

Update secrets in an organization

Declaration

public RestResponse PatchOrgsIDSecretsWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

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

Update secrets in an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> PatchOrgsIDSecretsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

PatchOrgsIDSecretsWithRestRequest(String, Dictionary<String, String>, String)

Update secrets in an organization

Declaration

public RestRequest PatchOrgsIDSecretsWithRestRequest(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
RestRequest	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

public 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

public 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

public 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

PostOrgsIDSecretsAsyncWithIRestResponse(String, SecretKeys, String, CancellationToken)

Delete secrets from an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> PostOrgsIDSecretsAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse

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

public 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

PostOrgsIDSecretsWithIRestResponse(String, SecretKeys, String)

Delete secrets from an organization

Declaration

public RestResponse PostOrgsIDSecretsWithIRestResponse(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
RestResponse	ApiResponse of Object(void)

Exceptions

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

PostOrgsIDSecretsWithIRestResponseAsync(String, SecretKeys, String, CancellationToken)

Delete secrets from an organization

Declaration

public System.Threading.Tasks.Task<RestResponse> PostOrgsIDSecretsWithIRestResponseAsync(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<RestResponse>	ApiResponse of Object(void)

Exceptions

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

PostOrgsIDSecretsWithRestRequest(String, SecretKeys, String)

Delete secrets from an organization

Declaration

public RestRequest PostOrgsIDSecretsWithRestRequest(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
RestRequest	ApiResponse of Object(void)

Exceptions

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

ISecretsService