summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2015-02-10 12:43:56 -0800
committerJoffrey F <joffrey@docker.com>2015-02-10 12:55:44 -0800
commita7f7fbb0fdd1ad247c413170c354d08deb43dd32 (patch)
treeb2fae940cc7a74caa1c8345f991cd6314e7f4a50 /docs/api.md
parent35c4cbd9c49d70922802aa19cb57c302c9bc9d8b (diff)
downloaddocker-py-rename_container.tar.gz
rename() tests and docsrename_container
Diffstat (limited to 'docs/api.md')
-rw-r--r--docs/api.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index dba4cde..1d162e9 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -526,6 +526,15 @@ Remove an image. Similar to the `docker rmi` command.
* force (bool): Force removal of the image
* noprune (bool): Do not delete untagged parents
+## 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
+
## restart
Restart a container. Similar to the `docker restart` command.