View Source DockerEngineAPI.Api.Config (docker_engine_api v1.43.0)
API calls for all endpoints tagged Config
.
Summary
Functions
Create a config
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :body (object):
Returns
} on success {:error, info} on failure
Delete a config
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): ID of the config
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
Inspect a config
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): ID of the config
- opts (KeywordList): [optional] Optional parameters
Returns
} on success {:error, info} on failure
List configs
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 configs list. Available filters: - `id=<config id>` - `label=<key> or label=<key>=value` - `name=<config name>` - `names=<config name>`
Returns
, ...]} on success {:error, info} on failure
Update a Config
Parameters
- connection (DockerEngineAPI.Connection): Connection to server
- id (String.t): The ID or name of the config
- version (integer()): The version number of the config object being updated. This is required to avoid conflicting writes.
- opts (KeywordList): [optional] Optional parameters
- :body (ConfigSpec): The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the ConfigInspect endpoint response values.
Returns
} on success {:error, info} on failure