dict
docker.auth.AuthConfig
- No class docstring; 0/4 property, 0/2 instance variable, 1/7 method, 2/2 class methods documenteddocker.types.base.DictType
- Undocumenteddocker.types.containers.DeviceRequest
- Create a device request to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`.docker.types.containers.LogConfig
- Configure logging for a container, when provided as an argument to :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`. You may refer to the `official logging driver documentation <https://docs...docker.types.containers.Ulimit
- Create a ulimit declaration to be used with :py:meth:`~docker.api.container.ContainerApiMixin.create_host_config`.docker.types.healthcheck.Healthcheck
- Defines a healthcheck configuration for a container or service.docker.types.containers.ContainerConfig
- Undocumenteddocker.types.containers.HostConfig
- Undocumenteddocker.types.networks.EndpointConfig
- Undocumenteddocker.types.networks.IPAMConfig
- Create an IPAM (IP Address Management) config dictionary to be used with :py:meth:`~docker.api.network.NetworkApiMixin.create_network`.docker.types.networks.IPAMPool
- Create an IPAM pool config dictionary to be added to the ``pool_configs`` parameter of :py:class:`~docker.types.IPAMConfig`.docker.types.networks.NetworkingConfig
- Undocumenteddocker.types.services.ConfigReference
- Config reference to be used as part of a :py:class:`ContainerSpec`. Describes how a config is made accessible inside the service's containers.docker.types.services.ContainerSpec
- Describes the behavior of containers that are part of a task, and is used when declaring a :py:class:`~docker.types.TaskTemplate`.docker.types.services.DNSConfig
- Specification for DNS related configurations in resolver configuration file (``resolv.conf``). Part of a :py:class:`ContainerSpec` definition.docker.types.services.DriverConfig
- Indicates which driver to use, as well as its configuration. Can be used as ``log_driver`` in a :py:class:`~docker.types.ContainerSpec`, for the `driver_config` in a volume :py:class:`~docker.types.Mount`, or as the driver object in :py:meth:`create_secret`.docker.types.services.EndpointSpec
- Describes properties to access and load-balance a service.docker.types.services.Mount
- Describes a mounted folder's configuration inside a container. A list of :py:class:`Mount` would be used as part of a :py:class:`~docker.types.ContainerSpec`.docker.types.services.NetworkAttachmentConfig
- Network attachment options for a service.docker.types.services.Placement
- Placement constraints to be used as part of a :py:class:`TaskTemplate`docker.types.services.PlacementPreference
- Placement preference to be used as an element in the list of preferences for :py:class:`Placement` objects.docker.types.services.Privileges
- Security options for a service's containers. Part of a :py:class:`ContainerSpec` definition.docker.types.services.Resources
- Configures resource allocation for containers when made part of a :py:class:`~docker.types.ContainerSpec`.docker.types.services.RestartPolicy
- Used when creating a :py:class:`~docker.types.ContainerSpec`, dictates whether a container should restart after stopping or failing.docker.types.services.SecretReference
- Secret reference to be used as part of a :py:class:`ContainerSpec`. Describes how a secret is made accessible inside the service's containers.docker.types.services.ServiceMode
- Indicate whether a service or a job should be deployed as a replicated or global service, and associated parametersdocker.types.services.TaskTemplate
- Describe the task specification to be used when creating or updating a service.docker.types.services.UpdateConfig
- Used to specify the way container updates should be performed by a service.docker.types.services.RollbackConfig
- Used to specify the way container rollbacks should be performed by a servicedocker.types.swarm.SwarmExternalCA
- Configuration for forwarding signing requests to an external certificate authority.docker.types.swarm.SwarmSpec
- Describe a Swarm's configuration and options. Use :py:meth:`~docker.api.swarm.SwarmApiMixin.create_swarm_spec` to instantiate.docker.utils.proxy.ProxyConfig
- Hold the client's proxy configurationdocker.api.build.BuildApiMixin
- No class docstring; 0/1 instance variable, 2/3 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.config.ConfigApiMixin
- No class docstring; 4/4 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.container.ContainerApiMixin
- No class docstring; 29/31 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.daemon.DaemonApiMixin
- No class docstring; 0/1 instance variable, 6/6 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.exec_api.ExecApiMixin
- No class docstring; 4/4 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.image.ImageApiMixin
- No class docstring; 17/18 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.network.NetworkApiMixin
- No class docstring; 7/7 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.plugin.PluginApiMixin
- No class docstring; 11/11 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.secret.SecretApiMixin
- No class docstring; 4/4 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.service.ServiceApiMixin
- No class docstring; 8/8 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.swarm.SwarmApiMixin
- No class docstring; 12/12 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.api.volume.VolumeApiMixin
- No class docstring; 5/5 methods documenteddocker.api.client.APIClient
- A low-level client for the Docker Engine API.docker.client.DockerClient
- A client for communicating with a Docker server.docker.context.api.ContextAPI
- Context API. Contains methods for context management: create, list, remove, get, inspect.docker.context.context.Context
- A context.docker.credentials.store.Store
- No class docstring; 0/3 instance variable, 5/6 methods documenteddocker.models.resource.Collection
- A base class for representing all objects of a particular type on the server.docker.models.configs.ConfigCollection
- Configs on the Docker server.docker.models.containers.ContainerCollection
- No class docstring; 4/5 methods documenteddocker.models.images.ImageCollection
- No class docstring; 6/11 methods documenteddocker.models.networks.NetworkCollection
- Networks on the Docker server.docker.models.nodes.NodeCollection
- Nodes on the Docker server.docker.models.plugins.PluginCollection
- No class docstring; 4/4 methods documenteddocker.models.secrets.SecretCollection
- Secrets on the Docker server.docker.models.services.ServiceCollection
- Services on the Docker server.docker.models.volumes.VolumeCollection
- Volumes on the Docker server.docker.models.resource.Model
- A base class for representing a single object on the server.docker.models.configs.Config
- A config.docker.models.containers.Container
- Local representation of a container object. Detailed configuration may be accessed through the :py:attr:`attrs` attribute. Note that local attributes are cached; users may call :py:meth:`reload` to query the Docker daemon for the current properties, causing :py:attr:`attrs` to be refreshed.docker.models.images.Image
- An image on the server.docker.models.images.RegistryData
- Image metadata stored on the registry, including available platforms.docker.models.networks.Network
- A Docker network.docker.models.nodes.Node
- A node in a swarm.docker.models.plugins.Plugin
- A plugin on the server.docker.models.secrets.Secret
- A secret.docker.models.services.Service
- A service.docker.models.swarm.Swarm
- The server's Swarm state. This a singleton that must be reloaded to get the current state of the Swarm.docker.models.volumes.Volume
- A volume.docker.tls.TLSConfig
- TLS configuration.docker.transport.npipesocket.NpipeSocket
- Partial implementation of the socket API over windows named pipes. This implementation is only designed to be used as a client socket, and server-specific methods (bind, listen, accept...) are not implemented.docker.types.containers.LogConfigTypesEnum
- Undocumenteddocker.types.daemon.CancellableStream
- Stream wrapper for real-time events, logs, etc. from the server.docker.types.services.RestartConditionTypesEnum
- Undocumenteddocker.utils.build.Pattern
- Undocumenteddocker.utils.build.PatternMatcher
- UndocumentedException
docker.errors.DockerException
- A base class from which all other exceptions inherit.docker.errors.APIError
- An HTTP error from the API.docker.errors.NotFound
- Undocumenteddocker.errors.ImageNotFound
- Undocumenteddocker.errors.BuildError
- Undocumenteddocker.errors.ContainerError
- Represents a container that has exited with a non-zero exit code.docker.errors.ContextAlreadyExists
- Undocumenteddocker.errors.ContextException
- Undocumenteddocker.errors.ContextNotFound
- Undocumenteddocker.errors.DeprecatedMethod
- Undocumenteddocker.errors.ImageLoadError
- Undocumenteddocker.errors.InvalidArgument
- Undocumenteddocker.errors.InvalidConfigFile
- Undocumenteddocker.errors.InvalidRepository
- Undocumenteddocker.errors.InvalidVersion
- Undocumenteddocker.errors.MissingContextParameter
- Undocumenteddocker.errors.NullResource
- Undocumenteddocker.errors.TLSParameterError
- Undocumenteddocker.utils.socket.SocketError
- Undocumentedhttp.client.HTTPConnection
docker.transport.npipeconn.NpipeHTTPConnection
- Undocumenteddocker.transport.sshconn.SSHConnection
- Undocumenteddocker.transport.unixconn.UnixHTTPConnection
- Undocumentedio.RawIOBase
docker.transport.npipesocket.NpipeFileIOBase
- Undocumentedrequests.adapters.HTTPAdapter
docker.transport.basehttpadapter.BaseHTTPAdapter
- Undocumenteddocker.transport.npipeconn.NpipeHTTPAdapter
- Undocumenteddocker.transport.sshconn.SSHHTTPAdapter
- Undocumenteddocker.transport.ssladapter.SSLHTTPAdapter
- An HTTPS Transport Adapter that uses an arbitrary SSL version.docker.transport.unixconn.UnixHTTPAdapter
- Undocumentedrequests.exceptions.HTTPError
docker.errors.APIError
- An HTTP error from the API.docker.errors.NotFound
- Undocumenteddocker.errors.ImageNotFound
- Undocumentedrequests.packages.urllib3.connectionpool.HTTPConnectionPool
docker.transport.npipeconn.NpipeHTTPConnectionPool
- Undocumenteddocker.transport.sshconn.SSHConnectionPool
- Undocumenteddocker.transport.unixconn.UnixHTTPConnectionPool
- Undocumentedrequests.Session
docker.api.client.APIClient
- A low-level client for the Docker Engine API.RuntimeError
docker.credentials.errors.StoreError
- Undocumenteddocker.credentials.errors.CredentialsNotFound
- Undocumenteddocker.credentials.errors.InitializationError
- Undocumenteddocker.errors.StreamParseError
- Undocumentedsocket.socket
docker.transport.sshconn.SSHSocket
- UndocumentedValueError
docker.errors.NullResource
- Undocumented