DockerEngineAPI.Api.Secret (ex_docker_api v1.48.0)

API calls for all endpoints tagged Secret.

Summary

Functions

secret_create(connection, opts \\ [])

Create a secret

secret_delete(connection, id, opts \\ [])

Delete a secret

secret_inspect(connection, id, opts \\ [])

Inspect a secret

secret_list(connection, opts \\ [])

List secrets

secret_update(connection, id, version, opts \\ [])

Update a Secret

Functions

secret_create(connection, opts \\ [])

@spec secret_create(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, DockerEngineAPI.Model.IdResponse.t()}
  | {:error, Tesla.Env.t()}

Create a secret

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :body (SecretCreateRequest):

Returns

{:ok, DockerEngineAPI.Model.IdResponse.t} on success
{:error, Tesla.Env.t} on failure

secret_delete(connection, id, opts \\ [])

@spec secret_delete(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Delete a secret

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): ID of the secret
opts (keyword): Optional parameters

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure

secret_inspect(connection, id, opts \\ [])

@spec secret_inspect(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DockerEngineAPI.Model.Secret.t()}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Inspect a secret

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): ID of the secret
opts (keyword): Optional parameters

Returns

{:ok, DockerEngineAPI.Model.Secret.t} on success
{:error, Tesla.Env.t} on failure

secret_list(connection, opts \\ [])

@spec secret_list(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:ok, [DockerEngineAPI.Model.Secret.t()]}
  | {:error, Tesla.Env.t()}

List secrets

Parameters

connection (DockerEngineAPI.Connection): Connection to server
opts (keyword): Optional parameters
- :filters (String.t): A JSON encoded value of the filters (a map[string][]string) to process on the secrets list. Available filters: - id=<secret id> - label=<key> or label=<key>=value - name=<secret name> - names=<secret name>

Returns

{:ok, [%Secret{}, ...]} on success
{:error, Tesla.Env.t} on failure

secret_update(connection, id, version, opts \\ [])

@spec secret_update(Tesla.Env.client(), String.t(), integer(), keyword()) ::
  {:ok, nil}
  | {:ok, DockerEngineAPI.Model.ErrorResponse.t()}
  | {:error, Tesla.Env.t()}

Update a Secret

Parameters

connection (DockerEngineAPI.Connection): Connection to server
id (String.t): The ID or name of the secret
version (integer()): The version number of the secret object being updated. This is required to avoid conflicting writes.
opts (keyword): Optional parameters
- :body (SecretSpec): The spec of the secret to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the SecretInspect endpoint response values.

Returns

{:ok, nil} on success
{:error, Tesla.Env.t} on failure