.. _actions-index-label:

Docker actions list
###################

Docker action names are a mapping to the internal actions from the
`Docker API <https://docs.docker.com/engine/api/version-history/>`__.

.. create a fake doctree as we'll display the links ourself.

.. toctree::
   :hidden:
   :glob:

   *

Containers
----------

+--------------------------------------+-------------------------------------+
| action name                          | API description                     |
+======================================+=====================================+
| :doc:`containers-list`               | List containers                     |
+--------------------------------------+-------------------------------------+
| :doc:`containers-create`             | Create containers                   |
+--------------------------------------+-------------------------------------+
| containersInspect                    | Inspect container                   |
+--------------------------------------+-------------------------------------+
| containersListProcess                | List processes running inside       |
|                                      | a container                         |
+--------------------------------------+-------------------------------------+
| containersLogs                       | Get container logs                  |
+--------------------------------------+-------------------------------------+
| containersChanges                    | Get changes on a container’s        |
|                                      | filesystem                          |
+--------------------------------------+-------------------------------------+
| containersExport                     | Export a container                  |
+--------------------------------------+-------------------------------------+
| containersStats                      | Get container stats based on        |
|                                      | resource usage                      |
+--------------------------------------+-------------------------------------+
| containersResizeTTY                  | Resize a container TTY              |
+--------------------------------------+-------------------------------------+
| containersStart                      | Start a container                   |
+--------------------------------------+-------------------------------------+
| containersStop                       | Stop a container                    |
+--------------------------------------+-------------------------------------+
| containersRestart                    | Restart a container                 |
+--------------------------------------+-------------------------------------+
| containersKill                       | Kill a container                    |
+--------------------------------------+-------------------------------------+
| :doc:`containers-update`             | Update a container                  |
+--------------------------------------+-------------------------------------+
| containersRename                     | Rename a container                  |
+--------------------------------------+-------------------------------------+
| containersPause                      | Pause a container                   |
+--------------------------------------+-------------------------------------+
| containersAttach                     | Unpause a container                 |
+--------------------------------------+-------------------------------------+
| containersAttach                     | Attach to a container               |
+--------------------------------------+-------------------------------------+
| containersAttachWebsocket            | Attach to a container via a         |
|                                      | websocket                           |
+--------------------------------------+-------------------------------------+
| containersAttachWebsocket            | Wait for a container                |
+--------------------------------------+-------------------------------------+
| containersRemove                     | Remove a container                  |
+--------------------------------------+-------------------------------------+
| containersGetInfoAboutFiles          | Get information about files         |
|                                      | in a container                      |
+--------------------------------------+-------------------------------------+
| containersGetFilesystemArchive       | Get an archive of a filesystem      |
|                                      | resource in a container             |
+--------------------------------------+-------------------------------------+
| containersExtractArchiveToDirectory  | Extract an archive of files or      |
|                                      | folders to a directory              |
|                                      | in a container                      |
+--------------------------------------+-------------------------------------+
| containersPrune                      | Delete stopped containers           |
+--------------------------------------+-------------------------------------+

Images
------

+--------------------------------------+-------------------------------------+
| action name                          | API description                     |
+======================================+=====================================+
| imagesList                           | Returns a list of images on the     |
|                                      | server.                             |
+--------------------------------------+-------------------------------------+
| :doc:`images-build`                  | Build an image from a tar archive   |
|                                      | with a Dockerfile in it.            |
+--------------------------------------+-------------------------------------+
| :doc:`images-create`                 | Create an image by either pulling it|
|                                      | from a registry or importing it.    |
+--------------------------------------+-------------------------------------+
| :doc:`images-delete`                 | Remove an image, along with any     |
|                                      | untagged parent images that were.   |
|                                      | referenced by that image.           |
+--------------------------------------+-------------------------------------+
| :doc:`images-inspect`                | Return low-level information about  |
|                                      | an image.                           |
+--------------------------------------+-------------------------------------+
| :doc:`images-commit`                 | Create a new image from a container.|
+--------------------------------------+-------------------------------------+