View Source DockerEngineAPI.Api.Secret (docker_engine_api v1.43.0)
API calls for all endpoints tagged Secret
.
Summary
Functions
Create a secret
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :body (object):
Returns
} on success {:error, info} on failure
Delete a secret
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): ID of the secret
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Inspect a secret
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): ID of the secret
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
List secrets
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] 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
, ...]} on success {:error, info} on failure
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 (KeywordList): [optional] 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
} on success {:error, info} on failure