api.config

Module Contents

Classes

ConfigApiMixin()
class ConfigApiMixin
create_config(name, data, labels=None)

Create a config

Args:
name (string): Name of the config data (bytes): Config data to be stored labels (dict): A mapping of labels to assign to the config

Returns (dict): ID of the newly created config

inspect_config(id)

Retrieve config metadata

Args:
id (string): Full ID of the config to remove

Returns (dict): A dictionary of metadata

Raises:
docker.errors.NotFound
if no config with that ID exists
remove_config(id)

Remove a config

Args:
id (string): Full ID of the config to remove

Returns (boolean): True if successful

Raises:
docker.errors.NotFound
if no config with that ID exists
configs(filters=None)

List configs

Args:
filters (dict): A map of filters to process on the configs list. Available filters: names

Returns (list): A list of configs