docker-py API reference

111 public APIs from docker-py (docker/docker-py) — 32 classes, 2 functions, 77 methods. Signatures extracted by static analysis of the actual source.

Repository: docker/docker-py

Kind	Count
Classes	32
Functions	2
Methods	77

API list

classdocker.api.client.APIClient

A low-level client for the Docker Engine API.

classdocker.client.DockerClient

A client for communicating with a Docker server.

classdocker.context.api.ContextAPI

Context API.

methoddocker.context.api.ContextAPI.contexts()

Context list.

methoddocker.context.api.ContextAPI.get_context(name=None)

Retrieves a context object.

methoddocker.context.api.ContextAPI.get_current_context()

Get current context.

methoddocker.context.api.ContextAPI.inspect_context(name='default')

Remove a context.

methoddocker.context.api.ContextAPI.remove_context(name)

Remove a context.

classdocker.context.context.Context

A context.

methoddocker.credentials.store.Store.erase(server)

Erase credentials for `server`.

methoddocker.credentials.store.Store.get(server)

Retrieve credentials for `server`.

methoddocker.credentials.store.Store.list()

List stored credentials.

methoddocker.credentials.store.Store.store(server, username, secret)

Store credentials for `server`.

classdocker.errors.APIError

An HTTP error from the API.

classdocker.errors.DockerException

A base class from which all other exceptions inherit.

classdocker.models.configs.Config

A config.

methoddocker.models.configs.Config.remove()

Remove this config.

classdocker.models.configs.ConfigCollection

Configs on the Docker server.

methoddocker.models.configs.ConfigCollection.get(config_id)

Get a config.

methoddocker.models.configs.ConfigCollection.list(**kwargs)

List configs.

classdocker.models.containers.Container

Local representation of a container object.

methoddocker.models.containers.Container.attach(**kwargs)

Attach to this container.

methoddocker.models.containers.Container.image()

The image of the container.

methoddocker.models.containers.Container.logs(**kwargs)

Get logs from this container.

methoddocker.models.containers.Container.name()

The name of the container.

methoddocker.models.containers.Container.remove(**kwargs)

Remove this container.

methoddocker.models.containers.Container.rename(name)

Rename this container.

methoddocker.models.containers.Container.resize(height, width)

Resize the tty session.

methoddocker.models.containers.Container.restart(**kwargs)

Restart this container.

methoddocker.models.containers.Container.start(**kwargs)

Start this container.

methoddocker.models.containers.Container.status()

The status of the container.

methoddocker.models.containers.Container.stop(**kwargs)

Stops a container.

classdocker.models.images.Image

An image on the server.

methoddocker.models.images.Image.history()

Show the history of an image.

methoddocker.models.images.Image.labels()

The labels of an image as dictionary.

methoddocker.models.images.Image.remove(force=False, noprune=False)

Remove this image.

methoddocker.models.images.Image.save(chunk_size=DEFAULT_DATA_CHUNK_SIZE, named=False)

Get a tarball of an image.

methoddocker.models.images.Image.tag(repository, tag=None, **kwargs)

Tag this image into a repository.

methoddocker.models.images.Image.tags()

The image's tags.

methoddocker.models.images.ImageCollection.build(**kwargs)

Build an image and return it.

methoddocker.models.images.ImageCollection.get(name)

Gets an image.

methoddocker.models.images.ImageCollection.list(name=None, all=False, filters=None)

List images on the server.

methoddocker.models.images.RegistryData.id()

The ID of the object.

methoddocker.models.images.RegistryData.pull(platform=None)

Pull the image digest.

classdocker.models.networks.Network

A Docker network.

methoddocker.models.networks.Network.name()

The name of the network.

methoddocker.models.networks.Network.remove()

Remove this network.

classdocker.models.networks.NetworkCollection

Networks on the Docker server.

methoddocker.models.networks.NetworkCollection.create(name, *args, **kwargs)

Create a network.

methoddocker.models.networks.NetworkCollection.get(network_id, *args, **kwargs)

Get a network by its ID.

methoddocker.models.networks.NetworkCollection.list(*args, **kwargs)

List networks.

classdocker.models.nodes.Node

A node in a swarm.

methoddocker.models.nodes.Node.remove(force=False)

Remove this node from the swarm.

methoddocker.models.nodes.Node.update(node_spec)

Update the node's configuration.

methoddocker.models.nodes.Node.version()

The version number of the service.

classdocker.models.nodes.NodeCollection

Nodes on the Docker server.

methoddocker.models.nodes.NodeCollection.get(node_id)

Get a node.

methoddocker.models.nodes.NodeCollection.list(*args, **kwargs)

List swarm nodes.

classdocker.models.plugins.Plugin

A plugin on the server.

methoddocker.models.plugins.Plugin.configure(options)

Update the plugin's settings.

methoddocker.models.plugins.Plugin.disable(force=False)

Disable the plugin.

methoddocker.models.plugins.Plugin.enable(timeout=0)

Enable the plugin.

methoddocker.models.plugins.Plugin.enabled()

Whether the plugin is enabled.

methoddocker.models.plugins.Plugin.name()

The plugin's name.

methoddocker.models.plugins.Plugin.push()

Push the plugin to a remote registry.

methoddocker.models.plugins.Plugin.remove(force=False)

Remove the plugin from the server.

methoddocker.models.plugins.Plugin.upgrade(remote=None)

Upgrade the plugin.

methoddocker.models.plugins.PluginCollection.create(name, plugin_data_dir, gzip=False)

Create a new plugin.

methoddocker.models.plugins.PluginCollection.get(name)

Gets a plugin.

methoddocker.models.plugins.PluginCollection.install(remote_name, local_name=None)

Pull and install a plugin.

methoddocker.models.plugins.PluginCollection.list()

List plugins installed on the server.

methoddocker.models.resource.Collection.prepare_model(attrs)

Create a model from a set of attributes.

classdocker.models.resource.Model

A base class for representing a single object on the server.

methoddocker.models.resource.Model.id()

The ID of the object.

classdocker.models.secrets.Secret

A secret.

methoddocker.models.secrets.Secret.remove()

Remove this secret.

classdocker.models.secrets.SecretCollection

Secrets on the Docker server.

methoddocker.models.secrets.SecretCollection.get(secret_id)

Get a secret.

methoddocker.models.secrets.SecretCollection.list(**kwargs)

List secrets.

classdocker.models.services.Service

A service.

methoddocker.models.services.Service.logs(**kwargs)

Get log stream for the service.

methoddocker.models.services.Service.name()

The service's name.

methoddocker.models.services.Service.remove()

Stop and remove the service.

methoddocker.models.services.Service.scale(replicas)

Scale service container.

methoddocker.models.services.Service.update(**kwargs)

Update a service's configuration.

methoddocker.models.services.Service.version()

The version number of the service.

classdocker.models.services.ServiceCollection

Services on the Docker server.

methoddocker.models.services.ServiceCollection.create(image, command=None, **kwargs)

Create a service.

methoddocker.models.services.ServiceCollection.get(service_id, insert_defaults=None)

Get a service.

methoddocker.models.services.ServiceCollection.list(**kwargs)

List services.

classdocker.models.swarm.Swarm

The server's Swarm state.

methoddocker.models.swarm.Swarm.version()

The version number of the swarm.

classdocker.models.volumes.Volume

A volume.

methoddocker.models.volumes.Volume.name()

The name of the volume.

methoddocker.models.volumes.Volume.remove(force=False)

Remove this volume.

classdocker.models.volumes.VolumeCollection

Volumes on the Docker server.

methoddocker.models.volumes.VolumeCollection.create(name=None, **kwargs)

Create a volume.

methoddocker.models.volumes.VolumeCollection.get(volume_id)

Get a volume.

methoddocker.models.volumes.VolumeCollection.list(**kwargs)

List volumes.

classdocker.tls.TLSConfig

TLS configuration.

classdocker.types.daemon.CancellableStream

Stream wrapper for real-time events, logs, etc.

methoddocker.types.daemon.CancellableStream.close()

Closes the event streaming.

classdocker.types.services.DriverConfig

Indicates which driver to use, as well as its configuration.

classdocker.types.services.EndpointSpec

Describes properties to access and load-balance a service.

classdocker.types.services.Mount

Describes a mounted folder's configuration inside a container.

classdocker.types.services.NetworkAttachmentConfig

Network attachment options for a service.

classdocker.types.services.Privileges

Security options for a service's containers.

classdocker.types.swarm.SwarmSpec

Describe a Swarm's configuration and options.

funcdocker.utils.fnmatch.fnmatch(name, pat)

Test whether FILENAME matches PATTERN.

classdocker.utils.proxy.ProxyConfig

Hold the client's proxy configuration

funcdocker.utils.socket.read(socket, n=4096)

Reads at most n bytes from socket

About this data

These signatures were extracted from the public source of docker/docker-py using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries