diff options
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 116 |
1 files changed, 116 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..5e59aa7 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,116 @@ +Low-level API +============= + +The main object-orientated API is built on top of :py:class:`APIClient`. Each method on :py:class:`APIClient` maps one-to-one with a REST API endpoint, and returns the response that the API responds with. + +It's possible to use :py:class:`APIClient` directly. Some basic things (e.g. running a container) consist of several API calls and are complex to do with the low-level API, but it's useful if you need extra flexibility and power. + +.. py:module:: docker.api + +.. autoclass:: docker.api.client.APIClient + +Containers +---------- + +.. py:module:: docker.api.container + +.. rst-class:: hide-signature +.. autoclass:: ContainerApiMixin + :members: + :undoc-members: + +.. py:module:: docker.api.image + +Images +------ + +.. py:module:: docker.api.image + +.. rst-class:: hide-signature +.. autoclass:: ImageApiMixin + :members: + :undoc-members: + +Building images +--------------- + +.. py:module:: docker.api.build + +.. rst-class:: hide-signature +.. autoclass:: BuildApiMixin + :members: + :undoc-members: + +Networks +-------- + +.. rst-class:: hide-signature +.. autoclass:: docker.api.network.NetworkApiMixin + :members: + :undoc-members: + +Volumes +------- + +.. py:module:: docker.api.volume + +.. rst-class:: hide-signature +.. autoclass:: VolumeApiMixin + :members: + :undoc-members: + +Executing commands in containers +-------------------------------- + +.. py:module:: docker.api.exec_api + +.. rst-class:: hide-signature +.. autoclass:: ExecApiMixin + :members: + :undoc-members: + +Swarms +------ + +.. py:module:: docker.api.swarm + +.. rst-class:: hide-signature +.. autoclass:: SwarmApiMixin + :members: + :undoc-members: + +Services +-------- + +.. py:module:: docker.api.service + +.. rst-class:: hide-signature +.. autoclass:: ServiceApiMixin + :members: + :undoc-members: + +The Docker daemon +----------------- + +.. py:module:: docker.api.daemon + +.. rst-class:: hide-signature +.. autoclass:: DaemonApiMixin + :members: + :undoc-members: + +Configuration types +------------------- + +.. py:module:: docker.types + +.. autoclass:: IPAMConfig +.. autoclass:: IPAMPool +.. autoclass:: ContainerSpec +.. autoclass:: DriverConfig +.. autoclass:: EndpointSpec +.. autoclass:: Mount +.. autoclass:: Resources +.. autoclass:: RestartPolicy +.. autoclass:: TaskTemplate +.. autoclass:: UpdateConfig |