docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
docker-py/docs/api.md

35 KiB
Raw Blame History

Client API

To instantiate a Client class that will allow you to communicate with a Docker daemon, simply do:

>>> from docker import Client
>>> cli = Client(base_url='unix://var/run/docker.sock')

Params:

  • base_url (str): Refers to the protocol+hostname+port where the Docker server is hosted.
  • version (str): The version of the API the client will use. Specify 'auto' to use the API version provided by the server.
  • timeout (int): The HTTP request timeout, in seconds.
  • tls (bool or TLSConfig): Equivalent CLI options: docker --tls ...
  • user_agent (str): Set a custom user agent for requests to the server.

attach

The .logs() function is a wrapper around this method, which you can use instead if you want to fetch/stream container output without first retrieving the entire backlog.

Params:

  • container (str): The container to attach to
  • stdout (bool): Get STDOUT
  • stderr (bool): Get STDERR
  • stream (bool): Return an iterator
  • logs (bool): Get all previous output

Returns (generator or str): The logs or output for the image

build

Similar to the docker build command. Either path or fileobj needs to be set. path can be a local path (to a directory containing a Dockerfile) or a remote URL. fileobj must be a readable file-like object to a Dockerfile.

If you have a tar file for the Docker build context (including a Dockerfile) already, pass a readable file-like object to fileobj and also pass custom_context=True. If the stream is compressed also, set encoding to the correct value (e.g gzip).

Params:

  • path (str): Path to the directory containing the Dockerfile
  • tag (str): A tag to add to the final image
  • quiet (bool): Whether to return the status
  • fileobj: A file object to use as the Dockerfile. (Or a file-like object)
  • nocache (bool): Don't use the cache when set to True
  • rm (bool): Remove intermediate containers. The docker build command now defaults to --rm=true, but we have kept the old default of False to preserve backward compatibility
  • stream (bool): Deprecated for API version > 1.8 (always True). Return a blocking generator you can iterate over to retrieve build output as it happens
  • timeout (int): HTTP timeout
  • custom_context (bool): Optional if using fileobj
  • encoding (str): The encoding for a stream. Set to gzip for compressing
  • pull (bool): Downloads any updates to the FROM image in Dockerfiles
  • forcerm (bool): Always remove intermediate containers, even after unsuccessful builds
  • dockerfile (str): path within the build context to the Dockerfile
  • buildargs (dict): A dictionary of build arguments
  • container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys:
    • memory (int): set memory limit for build
    • memswap (int): Total memory (memory + swap), -1 to disable swap
    • cpushares (int): CPU shares (relative weight)
    • cpusetcpus (str): CPUs in which to allow execution, e.g., "0-3", "0,1"
  • decode (bool): If set to True, the returned stream will be decoded into dicts on the fly. Default False.
  • shmsize (int): Size of /dev/shm in bytes. The size must be greater than 0. If omitted the system uses 64MB.
  • labels (dict): A dictionary of labels to set on the image

Returns (generator): A generator for the build output

>>> from io import BytesIO
>>> from docker import Client
>>> dockerfile = '''
... # Shared Volume
... FROM busybox:buildroot-2014.02
... MAINTAINER first last, first.last@yourdomain.com
... VOLUME /data
... CMD ["/bin/sh"]
... '''
>>> f = BytesIO(dockerfile.encode('utf-8'))
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> response = [line for line in cli.build(
...     fileobj=f, rm=True, tag='yourname/volume'
... )]
>>> response
['{"stream":" ---\\u003e a9eb17255234\\n"}',
'{"stream":"Step 1 : MAINTAINER first last, first.last@yourdomain.com\\n"}',
'{"stream":" ---\\u003e Running in 08787d0ee8b1\\n"}',
'{"stream":" ---\\u003e 23e5e66a4494\\n"}',
'{"stream":"Removing intermediate container 08787d0ee8b1\\n"}',
'{"stream":"Step 2 : VOLUME /data\\n"}',
'{"stream":" ---\\u003e Running in abdc1e6896c6\\n"}',
'{"stream":" ---\\u003e 713bca62012e\\n"}',
'{"stream":"Removing intermediate container abdc1e6896c6\\n"}',
'{"stream":"Step 3 : CMD [\\"/bin/sh\\"]\\n"}',
'{"stream":" ---\\u003e Running in dba30f2a1a7e\\n"}',
'{"stream":" ---\\u003e 032b8b2855fc\\n"}',
'{"stream":"Removing intermediate container dba30f2a1a7e\\n"}',
'{"stream":"Successfully built 032b8b2855fc\\n"}']

Raises: TypeError if path nor fileobj are specified

commit

Identical to the docker commit command.

Params:

  • container (str): The image hash of the container
  • repository (str): The repository to push the image to
  • tag (str): The tag to push
  • message (str): A commit message
  • author (str): The name of the author
  • changes (str): Dockerfile instructions to apply while committing
  • conf (dict): The configuration for the container. See the Docker remote api for full details.

containers

List containers. Identical to the docker ps command.

Params:

  • quiet (bool): Only display numeric Ids

  • all (bool): Show all containers. Only running containers are shown by default

  • trunc (bool): Truncate output

  • latest (bool): Show only the latest created container, include non-running ones.

  • since (str): Show only containers created since Id or Name, include non-running ones

  • before (str): Show only container created before Id or Name, include non-running ones

  • limit (int): Show limit last created containers, include non-running ones

  • size (bool): Display sizes

  • filters (dict): Filters to be processed on the image list. Available filters:

    • exited (int): Only containers with specified exit code
    • status (str): One of restarting, running, paused, exited
    • label (str): format either "key" or "key=value"
    • id (str): The id of the container.
    • name (str): The name of the container.
    • ancestor (str): Filter by container ancestor. Format of <image-name>[:tag], <image-id>, or <image@digest>.
    • before (str): Only containers created before a particular container. Give the container name or id.
    • since (str): Only containers created after a particular container. Give container name or id.

    A comprehensive list can be found here

Returns (dict): The system's containers

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> cli.containers()
[{'Command': '/bin/sleep 30',
  'Created': 1412574844,
  'Id': '6e276c9e6e5759e12a6a9214efec6439f80b4f37618e1a6547f28a3da34db07a',
  'Image': 'busybox:buildroot-2014.02',
  'Names': ['/grave_mayer'],
  'Ports': [],
  'Status': 'Up 1 seconds'}]

connect_container_to_network

Connect a container to a network.

Params:

  • container (str): container-id/name to be connected to the network
  • net_id (str): network id
  • aliases (list): A list of aliases for this endpoint. Names in that list can be used within the network to reach the container. Defaults to None.
  • links (list): A list of links for this endpoint. Containers declared in this list will be linked to this container. Defaults to None.
  • ipv4_address (str): The IP address of this container on the network, using the IPv4 protocol. Defaults to None.
  • ipv6_address (str): The IP address of this container on the network, using the IPv6 protocol. Defaults to None.
  • link_local_ips (list): A list of link-local (IPv4/IPv6) addresses.

copy

Identical to the docker cp command. Get files/folders from the container. Deprecated for API version >= 1.20 – Consider using get_archive instead.

Params:

  • container (str): The container to copy from
  • resource (str): The path within the container

Returns (str): The contents of the file as a string

create_container

Creates a container that can then be .start() ed. Parameters are similar to those for the docker run command except it doesn't support the attach options (-a).

See Port bindings and Using volumes for more information on how to create port bindings and volume mappings.

The mem_limit variable accepts float values (which represent the memory limit of the created container in bytes) or a string with a units identification char ('100000b', '1000k', '128m', '1g'). If a string is specified without a units character, bytes are assumed as an intended unit.

volumes_from and dns arguments raise TypeError exception if they are used against v1.10 and above of the Docker remote API. Those arguments should be passed as part of the host_config dictionary.

Params:

  • image (str): The image to run
  • command (str or list): The command to be run in the container
  • hostname (str): Optional hostname for the container
  • user (str or int): Username or UID
  • detach (bool): Detached mode: run container in the background and print new container Id
  • stdin_open (bool): Keep STDIN open even if not attached
  • tty (bool): Allocate a pseudo-TTY
  • mem_limit (float or str): Memory limit (format: [number][optional unit], where unit = b, k, m, or g)
  • ports (list of ints): A list of port numbers
  • environment (dict or list): A dictionary or a list of strings in the following format ["PASSWORD=xxx"] or {"PASSWORD": "xxx"}.
  • dns (list): DNS name servers
  • dns_opt (list): Additional options to be added to the container's resolv.conf file
  • volumes (str or list):
  • volumes_from (str or list): List of container names or Ids to get volumes from. Optionally a single string joining container id's with commas
  • network_disabled (bool): Disable networking
  • name (str): A name for the container
  • entrypoint (str or list): An entrypoint
  • working_dir (str): Path to the working directory
  • domainname (str or list): Set custom DNS search domains
  • memswap_limit (int):
  • host_config (dict): A HostConfig dictionary
  • mac_address (str): The Mac Address to assign the container
  • labels (dict or list): A dictionary of name-value labels (e.g. {"label1": "value1", "label2": "value2"}) or a list of names of labels to set with empty values (e.g. ["label1", "label2"])
  • volume_driver (str): The name of a volume driver/plugin.
  • stop_signal (str): The stop signal to use to stop the container (e.g. SIGINT).
  • networking_config (dict): A NetworkingConfig dictionary

Returns (dict): A dictionary with an image 'Id' key and a 'Warnings' key.

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> container = cli.create_container(image='busybox:latest', command='/bin/sleep 30')
>>> print(container)
{'Id': '8a61192da2b3bb2d922875585e29b74ec0dc4e0117fcbf84c962204e97564cd7',
 'Warnings': None}

docker.utils.parse_env_file

A utility for parsing an environment file.

The expected format of the file is as follows:

USERNAME=jdoe
PASSWORD=secret

The utility can be used as follows:

>>> import docker.utils
>>> my_envs = docker.utils.parse_env_file('/path/to/file')
>>> client.create_container('myimage', 'command', environment=my_envs)

create_network

Create a network, similar to the docker network create command. See the networks documentation for details.

Params:

  • name (str): Name of the network
  • driver (str): Name of the driver used to create the network
  • options (dict): Driver options as a key-value dictionary
  • ipam (dict): Optional custom IP scheme for the network
  • check_duplicate (bool): Request daemon to check for networks with same name. Default: True.
  • internal (bool): Restrict external access to the network. Default False.
  • labels (dict): Map of labels to set on the network. Default None.
  • enable_ipv6 (bool): Enable IPv6 on the network. Default False.

Returns (dict): The created network reference object

create_service

Create a service, similar to the docker service create command. See the services documentation for details.

create_volume

Create and register a named volume

Params:

  • name (str): Name of the volume
  • driver (str): Name of the driver used to create the volume
  • driver_opts (dict): Driver options as a key-value dictionary
  • labels (dict): Labels to set on the volume

Returns (dict): The created volume reference object

>>> from docker import Client
>>> cli = Client()
>>> volume = cli.create_volume(
  name='foobar', driver='local', driver_opts={'foo': 'bar', 'baz': 'false'},
  labels={"key": "value"}
)
>>> print(volume)
{
  u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data',
  u'Driver': u'local',
  u'Name': u'foobar',
  u'Labels': {u'key': u'value'}
}

diff

Inspect changes on a container's filesystem.

Params:

  • container (str): The container to diff

Returns (str):

disconnect_container_from_network

Params:

  • container (str): container-id/name to be disconnected from a network
  • net_id (str): network id
  • force (bool): Force the container to disconnect from a network. Default: False

events

Identical to the docker events command: get real time events from the server. The events function return a blocking generator you can iterate over to retrieve events as they happen.

Params:

  • since (UTC datetime or int): get events from this point
  • until (UTC datetime or int): get events until this point
  • filters (dict): filter the events by event time, container or image
  • decode (bool): If set to true, stream will be decoded into dicts on the fly. False by default.

Returns (generator):

{u'status': u'start',
 u'from': u'image/with:tag',
 u'id': u'container-id',
 u'time': 1423339459}

execute

This command is deprecated for docker-py >= 1.2.0 ; use exec_create and exec_start instead.

exec_create

Sets up an exec instance in a running container.

Params:

  • container (str): Target container where exec instance will be created
  • cmd (str or list): Command to be executed
  • stdout (bool): Attach to stdout of the exec command if true. Default: True
  • stderr (bool): Attach to stderr of the exec command if true. Default: True
  • since (UTC datetime or int): Output logs from this timestamp. Default: None (all logs are given)
  • tty (bool): Allocate a pseudo-TTY. Default: False
  • user (str): User to execute command as. Default: root

Returns (dict): A dictionary with an exec 'Id' key.

exec_inspect

Return low-level information about an exec command.

Params:

  • exec_id (str): ID of the exec instance

Returns (dict): Dictionary of values returned by the endpoint.

exec_resize

Resize the tty session used by the specified exec command.

Params:

  • exec_id (str): ID of the exec instance
  • height (int): Height of tty session
  • width (int): Width of tty session

exec_start

Start a previously set up exec instance.

Params:

  • exec_id (str): ID of the exec instance
  • detach (bool): If true, detach from the exec command. Default: False
  • tty (bool): Allocate a pseudo-TTY. Default: False
  • stream (bool): Stream response data. Default: False

Returns (generator or str): If stream=True, a generator yielding response chunks. A string containing response data otherwise.

export

Export the contents of a filesystem as a tar archive to STDOUT.

Params:

  • container (str): The container to export

Returns (str): The filesystem tar archive as a str

get_archive

Retrieve a file or folder from a container in the form of a tar archive.

Params:

  • container (str): The container where the file is located
  • path (str): Path to the file or folder to retrieve

Returns (tuple): First element is a raw tar data stream. Second element is a dict containing stat information on the specified path.

>>> import docker
>>> cli = docker.Client()
>>> ctnr = cli.create_container('busybox', 'true')
>>> strm, stat = cli.get_archive(ctnr, '/bin/sh')
>>> print(stat)
{u'linkTarget': u'', u'mode': 493, u'mtime': u'2015-09-16T12:34:23-07:00', u'name': u'sh', u'size': 962860}

get_image

Get an image from the docker daemon. Similar to the docker save command.

Params:

  • image (str): Image name to get

Returns (urllib3.response.HTTPResponse object): The response from the docker daemon

An example of how to get (save) an image to a file.

>>> from docker import Client
>>> cli = Client(base_url='unix://var/run/docker.sock')
>>> image = cli.get_image(“fedora:latest”)
>>> image_tar = open(‘/tmp/fedora-latest.tar’,’w’)
>>> image_tar.write(image.data)
>>> image_tar.close()

history

Show the history of an image.

Params:

  • image (str): The image to show history for

Returns (str): The history of the image

images

List images. Identical to the docker images command.

Params:

  • name (str): Only show images belonging to the repository name
  • quiet (bool): Only show numeric Ids. Returns a list
  • all (bool): Show all images (by default filter out the intermediate image layers)
  • filters (dict): Filters to be processed on the image list. Available filters:
    • dangling (bool)
    • label (str): format either "key" or "key=value"

Returns (dict or list): A list if quiet=True, otherwise a dict.

[{'Created': 1401926735,
'Id': 'a9eb172552348a9a49180694790b33a1097f546456d041b6e82e4d7716ddb721',
'ParentId': '120e218dd395ec314e7b6249f39d2853911b3d6def6ea164ae05722649f34b16',
'RepoTags': ['busybox:buildroot-2014.02', 'busybox:latest'],
'Size': 0,
'VirtualSize': 2433303},
...

import_image

Similar to the docker import command.

If src is a string or unicode string, it will first be treated as a path to a tarball on the local system. If there is an error reading from that file, src will be treated as a URL instead to fetch the image from. You can also pass an open file handle as 'src', in which case the data will be read from that file.

If src is unset but image is set, the image parameter will be taken as the name of an existing image to import from.

Params:

  • src (str or file): Path to tarfile, URL, or file-like object
  • repository (str): The repository to create
  • tag (str): The tag to apply
  • image (str): Use another image like the FROM Dockerfile parameter

import_image_from_data

Like .import_image(), but allows importing in-memory bytes data.

Params:

  • data (bytes collection): Bytes collection containing valid tar data
  • repository (str): The repository to create
  • tag (str): The tag to apply

import_image_from_file

Like .import_image(), but only supports importing from a tar file on disk. If the file doesn't exist it will raise IOError.

Params:

  • filename (str): Full path to a tar file.
  • repository (str): The repository to create
  • tag (str): The tag to apply

import_image_from_url

Like .import_image(), but only supports importing from a URL.

Params:

  • url (str): A URL pointing to a tar file.
  • repository (str): The repository to create
  • tag (str): The tag to apply

import_image_from_image

Like .import_image(), but only supports importing from another image, like the FROM Dockerfile parameter.

Params:

  • image (str): Image name to import from
  • repository (str): The repository to create
  • tag (str): The tag to apply

info

Display system-wide information. Identical to the docker info command.

Returns (dict): The info as a dict

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> cli.info()
{'Containers': 3,
 'Debug': 1,
 'Driver': 'aufs',
 'DriverStatus': [['Root Dir', '/mnt/sda1/var/lib/docker/aufs'],
  ['Dirs', '225']],
 'ExecutionDriver': 'native-0.2',
 'IPv4Forwarding': 1,
 'Images': 219,
 'IndexServerAddress': 'https://index.docker.io/v1/',
 'InitPath': '/usr/local/bin/docker',
 'InitSha1': '',
 'KernelVersion': '3.16.1-tinycore64',
 'MemoryLimit': 1,
 'NEventsListener': 0,
 'NFd': 11,
 'NGoroutines': 12,
 'OperatingSystem': 'Boot2Docker 1.2.0 (TCL 5.3);',
 'SwapLimit': 1}

init_swarm

Initialize a new Swarm using the current connected engine as the first node. See the Swarm documentation.

insert

DEPRECATED

inspect_container

Identical to the docker inspect command, but only for containers.

Params:

  • container (str): The container to inspect

Returns (dict): Nearly the same output as docker inspect, just as a single dict

inspect_image

Identical to the docker inspect command, but only for images.

Params:

  • image (str): The image to inspect

Returns (dict): Nearly the same output as docker inspect, just as a single dict

inspect_network

Retrieve network info by id.

Params:

  • net_id (str): network id

Returns (dict): Network information dictionary

inspect_node

Retrieve low-level information about a Swarm node. See the Swarm documentation.

inspect_service

Create a service, similar to the docker service create command. See the services documentation for details.

inspect_swarm

Retrieve information about the current Swarm. See the Swarm documentation.

inspect_task

Retrieve information about a task.

Params:

  • task (str): Task identifier

Returns (dict): Task information dictionary

inspect_volume

Retrieve volume info by name.

Params:

  • name (str): volume name

Returns (dict): Volume information dictionary

>>> cli.inspect_volume('foobar')
{u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Driver': u'local', u'Name': u'foobar'}

join_swarm

Join an existing Swarm. See the Swarm documentation.

kill

Kill a container or send a signal to a container.

Params:

  • container (str): The container to kill
  • signal (str or int): The signal to send. Defaults to SIGKILL

leave_swarm

Leave the current Swarm. See the Swarm documentation.

load_image

Load an image that was previously saved using Client.get_image (or docker save). Similar to docker load.

Params:

  • data (binary): Image data to be loaded

login

Nearly identical to the docker login command, but non-interactive.

Params:

  • username (str): The registry username
  • password (str): The plaintext password
  • email (str): The email for the registry account
  • registry (str): URL to the registry. Ex:https://index.docker.io/v1/
  • reauth (bool): Whether refresh existing authentication on the docker server.
  • dockercfg_path (str): Use a custom path for the .dockercfg file (default $HOME/.dockercfg)

Returns (dict): The response from the login request

logs

Identical to the docker logs command. The stream parameter makes the logs function return a blocking generator you can iterate over to retrieve log output as it happens.

Params:

  • container (str): The container to get logs from
  • stdout (bool): Get STDOUT
  • stderr (bool): Get STDERR
  • stream (bool): Stream the response
  • timestamps (bool): Show timestamps
  • tail (str or int): Output specified number of lines at the end of logs: "all" or number. Default "all"
  • since (datetime or int): Show logs since a given datetime or integer epoch (in seconds)
  • follow (bool): Follow log output

Returns (generator or str):

networks

List networks currently registered by the docker daemon. Similar to the docker networks ls command.

Params

  • names (list): List of names to filter by
  • ids (list): List of ids to filter by

The above are combined to create a filters dict.

Returns (dict): List of network objects.

nodes

List Swarm nodes. See the Swarm documentation.

pause

Pauses all processes within a container.

Params:

  • container (str): The container to pause

ping

Hits the /_ping endpoint of the remote API and returns the result. An exception will be raised if the endpoint isn't responding.

Returns (bool)

port

Lookup the public-facing port that is NAT-ed to private_port. Identical to the docker port command.

Params:

  • container (str): The container to look up
  • private_port (int): The private port to inspect

Returns (list of dict): The mapping for the host ports

$ docker run -d -p 80:80 ubuntu:14.04 /bin/sleep 30
7174d6347063a83f412fad6124c99cffd25ffe1a0807eb4b7f9cec76ac8cb43b

>>> cli.port('7174d6347063', 80)
[{'HostIp': '0.0.0.0', 'HostPort': '80'}]

pull

Identical to the docker pull command.

Params:

  • repository (str): The repository to pull
  • tag (str): The tag to pull
  • stream (bool): Stream the output as a generator
  • insecure_registry (bool): Use an insecure registry
  • auth_config (dict): Override the credentials that Client.login has set for this request auth_config should contain the username and password keys to be valid.

Returns (generator or str): The output

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> for line in cli.pull('busybox', stream=True):
...     print(json.dumps(json.loads(line), indent=4))
{
    "status": "Pulling image (latest) from busybox",
    "progressDetail": {},
    "id": "e72ac664f4f0"
}
{
    "status": "Pulling image (latest) from busybox, endpoint: ...",
    "progressDetail": {},
    "id": "e72ac664f4f0"
}

push

Push an image or a repository to the registry. Identical to the docker push command.

Params:

  • repository (str): The repository to push to
  • tag (str): An optional tag to push
  • stream (bool): Stream the output as a blocking generator
  • insecure_registry (bool): Use http:// to connect to the registry
  • auth_config (dict): Override the credentials that Client.login has set for this request auth_config should contain the username and password keys to be valid.

Returns (generator or str): The output of the upload

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> response = [line for line in cli.push('yourname/app', stream=True)]
>>> response
['{"status":"Pushing repository yourname/app (1 tags)"}\\n',
 '{"status":"Pushing","progressDetail":{},"id":"511136ea3c5a"}\\n',
 '{"status":"Image already pushed, skipping","progressDetail":{},
    "id":"511136ea3c5a"}\\n',
 ...
 '{"status":"Pushing tag for rev [918af568e6e5] on {
    https://cdn-registry-1.docker.io/v1/repositories/
    yourname/app/tags/latest}"}\\n']

put_archive

Insert a file or folder in an existing container using a tar archive as source.

Params:

  • container (str): The container where the file(s) will be extracted
  • path (str): Path inside the container where the file(s) will be extracted. Must exist.
  • data (bytes): tar data to be extracted

Returns (bool): True if the call succeeds. docker.errors.APIError will be raised if an error occurs.

remove_container

Remove a container. Similar to the docker rm command.

Params:

  • container (str): The container to remove
  • v (bool): Remove the volumes associated with the container
  • link (bool): Remove the specified link and not the underlying container
  • force (bool): Force the removal of a running container (uses SIGKILL)

remove_image

Remove an image. Similar to the docker rmi command.

Params:

  • image (str): The image to remove
  • force (bool): Force removal of the image
  • noprune (bool): Do not delete untagged parents

remove_network

Remove a network. Similar to the docker network rm command.

Params:

  • net_id (str): The network's id

Failure to remove will raise a docker.errors.APIError exception.

remove_service

Remove a service, similar to the docker service rm command. See the services documentation for details.

remove_volume

Remove a volume. Similar to the docker volume rm command.

Params:

  • name (str): The volume's name

Failure to remove will raise a docker.errors.APIError exception.

rename

Rename a container. Similar to the docker rename command.

Params:

  • container (str): ID of the container to rename
  • name (str): New name for the container

resize

Resize the tty session.

Params:

  • container (str or dict): The container to resize
  • height (int): Height of tty session
  • width (int): Width of tty session

restart

Restart a container. Similar to the docker restart command.

If container a dict, the Id key is used.

Params:

  • container (str or dict): The container to restart
  • timeout (int): Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default is 10 seconds.

search

Identical to the docker search command.

Params:

  • term (str): A term to search for

Returns (list of dicts): The response of the search

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> response = cli.search('nginx')
>>> response[:2]
[{'description': 'Official build of Nginx.',
  'is_official': True,
  'is_trusted': False,
  'name': 'nginx',
  'star_count': 266},
 {'description': 'Trusted automated Nginx (http://nginx.org/) ...',
  'is_official': False,
  'is_trusted': True,
  'name': 'dockerfile/nginx',
  'star_count': 60},
  ...

services

List services, similar to the docker service ls command. See the services documentation for details.

start

Similar to the docker start command, but doesn't support attach options. Use .logs() to recover stdout/stderr.

Params:

  • container (str): The container to start

Deprecation warning: For API version > 1.15, it is highly recommended to provide host config options in the host_config parameter of create_container

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> container = cli.create_container(
...     image='busybox:latest',
...     command='/bin/sleep 30')
>>> response = cli.start(container=container.get('Id'))
>>> print(response)
None

stats

The Docker API parallel to the docker stats command. This will stream statistics for a specific container.

Params:

  • container (str): The container to stream statistics for
  • decode (bool): If set to true, stream will be decoded into dicts on the fly. False by default.
  • stream (bool): If set to false, only the current stats will be returned instead of a stream. True by default.
>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> stats_obj = cli.stats('elasticsearch')
>>> for stat in stats_obj:
>>>     print(stat)
{"read":"2015-02-11T21:47:30.49388286+02:00","networks":{"eth0":{"rx_bytes":648,"rx_packets":8 ...
...
...
...

stop

Stops a container. Similar to the docker stop command.

Params:

  • container (str): The container to stop
  • timeout (int): Timeout in seconds to wait for the container to stop before sending a SIGKILL. Default: 10

tag

Tag an image into a repository. Identical to the docker tag command.

Params:

  • image (str): The image to tag
  • repository (str): The repository to set for the tag
  • tag (str): The tag name
  • force (bool): Force

Returns (bool): True if successful

tasks

Retrieve a list of tasks.

Params:

  • filters (dict): A map of filters to process on the tasks list. Valid filters: id, name, service, node, label and desired-state.

Returns (list): List of task dictionaries.

top

Display the running processes of a container.

Params:

  • container (str): The container to inspect
  • ps_args (str): An optional arguments passed to ps (e.g., aux)

Returns (str): The output of the top

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> cli.create_container('busybox:latest', '/bin/sleep 30', name='sleeper')
>>> cli.start('sleeper')
>>> cli.top('sleeper')
{'Processes': [['952', 'root', '/bin/sleep 30']],
 'Titles': ['PID', 'USER', 'COMMAND']}

unpause

Unpause all processes within a container.

Params:

  • container (str): The container to unpause

update_container

Update resource configs of one or more containers.

Params:

  • container (str): The container to inspect
  • blkio_weight (int): Block IO (relative weight), between 10 and 1000
  • cpu_period (int): Limit CPU CFS (Completely Fair Scheduler) period
  • cpu_quota (int): Limit CPU CFS (Completely Fair Scheduler) quota
  • cpu_shares (int): CPU shares (relative weight)
  • cpuset_cpus (str): CPUs in which to allow execution
  • cpuset_mems (str): MEMs in which to allow execution
  • mem_limit (int or str): Memory limit
  • mem_reservation (int or str): Memory soft limit
  • memswap_limit (int or str): Total memory (memory + swap), -1 to disable swap
  • kernel_memory (int or str): Kernel memory limit
  • restart_policy (dict): Restart policy dictionary

Returns (dict): Dictionary containing a Warnings key.

update_node

Update a node. See the Swarm documentation.

update_service

Update a service, similar to the docker service update command. See the services documentation for details.

update_swarm

Update the current Swarm. See the Swarm documentation.

version

Nearly identical to the docker version command.

Returns (dict): The server version information

>>> from docker import Client
>>> cli = Client(base_url='tcp://127.0.0.1:2375')
>>> cli.version()
{
    "KernelVersion": "3.16.4-tinycore64",
    "Arch": "amd64",
    "ApiVersion": "1.15",
    "Version": "1.3.0",
    "GitCommit": "c78088f",
    "Os": "linux",
    "GoVersion": "go1.3.3"
}

volumes

List volumes currently registered by the docker daemon. Similar to the docker volume ls command.

Params

  • filters (dict): Server-side list filtering options.

Returns (dict): Dictionary with list of volume objects as value of the Volumes key.

>>> cli.volumes()
{u'Volumes': [
  {u'Mountpoint': u'/var/lib/docker/volumes/foobar/_data', u'Driver': u'local', u'Name': u'foobar'},
  {u'Mountpoint': u'/var/lib/docker/volumes/baz/_data', u'Driver': u'local', u'Name': u'baz'}
]}

wait

Identical to the docker wait command. Block until a container stops, then return its exit code. Returns the value -1 if the API responds without a StatusCode attribute.

If container is a dict, the Id key is used.

If the timeout value is exceeded, a requests.exceptions.ReadTimeout exception will be raised.

Params:

  • container (str or dict): The container to wait on
  • timeout (int): Request timeout

Returns (int): The exit code of the container

Version mismatch

You may encounter an error like this:

client is newer than server (client API version: 1.24, server API version: 1.23)

To fix this, you have to either supply the exact version your server supports when instantiating the Client:

client = docker.Client(version="1.23")

or let the client automatically detect the newest version server supports:

client = docker.Client(version="auto")