summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2014-10-29 19:35:05 +0100
committerJoffrey F <joffrey@docker.com>2014-10-29 19:35:05 +0100
commit37c8072f60412b1efdcdb0b5556bd87562e70cff (patch)
treef7d2417d30f8d53ccae9cc6b2685693c95bf95d8 /docs
parent0d806d81b47041f3b4563e81438163cc3b56853d (diff)
parent288e53b28b3eaf75260fb65befb9138aa62c49b8 (diff)
downloaddocker-py-37c8072f60412b1efdcdb0b5556bd87562e70cff.tar.gz
Merge branch 'pause-unpause' of github.com:phensley/docker-py into phensley-pause-unpause
Conflicts: README.md tests/integration_test.py tests/test.py
Diffstat (limited to 'docs')
-rw-r--r--docs/api.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 613e260..73fec4d 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -400,6 +400,15 @@ output as it happens.
**Returns** (generator or str):
+## 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
@@ -673,6 +682,14 @@ Display the running processes of a container
'Titles': ['PID', 'USER', 'COMMAND']}
```
+## unpause
+
+Unpauses all processes within a container.
+
+**Params**:
+
+* container (str): The container to unpause
+
## version
Nearly identical to the `docker version` command.