Package com.influxdb.client.service

Interface SecretsService

public interface SecretsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteOrgsIDSecretsID(String orgID, String secretID, String zapTraceSpan)	Delete a secret from an organization
retrofit2.Call<SecretKeysResponse>	getOrgsIDSecrets(String orgID, String zapTraceSpan)	List all secret keys for an organization
retrofit2.Call<Void>	patchOrgsIDSecrets(String orgID, Map<String,String> requestBody, String zapTraceSpan)	Update secrets in an organization
retrofit2.Call<Void>	postOrgsIDSecrets(String orgID, SecretKeys secretKeys, String zapTraceSpan)	Deprecated.

Method Details

deleteOrgsIDSecretsID

@DELETE("api/v2/orgs/{orgID}/secrets/{secretID}")
retrofit2.Call<Void> deleteOrgsIDSecretsID(@Path("orgID")
 String orgID,
 @Path("secretID")
 String secretID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a secret from an organization

Parameters:

orgID - The organization ID. (required)

secretID - The secret ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getOrgsIDSecrets

@GET("api/v2/orgs/{orgID}/secrets")
retrofit2.Call<SecretKeysResponse> getOrgsIDSecrets(@Path("orgID")
 String orgID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all secret keys for an organization

Parameters:

orgID - The organization ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<SecretKeysResponse>

patchOrgsIDSecrets

@Headers("Content-Type:application/json")
@PATCH("api/v2/orgs/{orgID}/secrets")
retrofit2.Call<Void> patchOrgsIDSecrets(@Path("orgID")
 String orgID,
 @Body
 Map<String,String> requestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update secrets in an organization

Parameters:

orgID - The organization ID. (required)

requestBody - Secret key value pairs to update/add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

postOrgsIDSecrets

@Deprecated
@Headers("Content-Type:application/json")
@POST("api/v2/orgs/{orgID}/secrets/delete")
retrofit2.Call<Void> postOrgsIDSecrets(@Path("orgID")
 String orgID,
 @Body
 SecretKeys secretKeys,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Deprecated.

Delete secrets from an organization

Parameters:

orgID - The organization ID. (required)

secretKeys - Secret key to delete (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>