summaryrefslogtreecommitdiff
path: root/docs/api.md
diff options
context:
space:
mode:
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.