From ee78e3f28459b655bf7df71eb4e2e22a04a8948d Mon Sep 17 00:00:00 2001 From: Jessica Frazelle Date: Tue, 13 Jan 2015 11:17:26 -0800 Subject: [PATCH] Add reference to rename endpoint in correct version & add to new Docker-DCO-1.1-Signed-off-by: Jessica Frazelle (github: jfrazelle) --- .../reference/api/docker_remote_api.md | 5 ++++ .../reference/api/docker_remote_api_v1.15.md | 21 ---------------- .../reference/api/docker_remote_api_v1.17.md | 25 +++++++++++++++++++ 3 files changed, 30 insertions(+), 21 deletions(-) diff --git a/docs/sources/reference/api/docker_remote_api.md b/docs/sources/reference/api/docker_remote_api.md index fa210d4583..08439ce0d4 100644 --- a/docs/sources/reference/api/docker_remote_api.md +++ b/docs/sources/reference/api/docker_remote_api.md @@ -56,6 +56,11 @@ Docker client now hints potential proxies about connection hijacking using HTTP **New!** This endpoint now returns the list current execs associated with the container (`ExecIDs`). +`POST /containers/(id)/rename` + +**New!** +New endpoint to rename a container `id` to a new name. + ## v1.16 ### Full Documentation diff --git a/docs/sources/reference/api/docker_remote_api_v1.15.md b/docs/sources/reference/api/docker_remote_api_v1.15.md index 7edfa91016..4d27a6150a 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.15.md +++ b/docs/sources/reference/api/docker_remote_api_v1.15.md @@ -647,27 +647,6 @@ Status Codes: - **404** – no such container - **500** – server error -### Rename a container - -`POST /containers/(id)/rename/(new_name)` - -Rename the container `id` to a `new_name` - -**Example request**: - - POST /containers/e90e34656806/rename/new_name HTTP/1.1 - -**Example response**: - - HTTP/1.1 204 No Content - -Status Codes: - -- **204** – no error -- **404** – no such container -- **409** - conflict name already assigned -- **500** – server error - ### Pause a container `POST /containers/(id)/pause` diff --git a/docs/sources/reference/api/docker_remote_api_v1.17.md b/docs/sources/reference/api/docker_remote_api_v1.17.md index 67b862302f..6c20394f6f 100644 --- a/docs/sources/reference/api/docker_remote_api_v1.17.md +++ b/docs/sources/reference/api/docker_remote_api_v1.17.md @@ -599,6 +599,31 @@ Status Codes: - **404** – no such container - **500** – server error +### Rename a container + +`POST /containers/(id)/rename` + +Rename the container `id` to a `new_name` + +**Example request**: + + POST /containers/e90e34656806/rename?name=new_name HTTP/1.1 + +**Example response**: + + HTTP/1.1 204 No Content + +Query Parameters: + +- **name** – new name for the container + +Status Codes: + +- **204** – no error +- **404** – no such container +- **409** - conflict name already assigned +- **500** – server error + ### Pause a container `POST /containers/(id)/pause`