Rename a container Run in API Explorer

POST /containers/{id}/rename

Path parameters

  • id string Required

    ID or name of the container

Query parameters

  • name string Required

    New name for the container

Responses

  • 204

    no error

  • 404 application/json

    no such container

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

  • 409 application/json

    name already in use

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

  • 500 application/json

    server error

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

POST /containers/{id}/rename
curl \
 --request POST 'http://api.example.com/v1.44/containers/{id}/rename?name=string'
Response examples (404)
{
  "message": "No such container: c2ada9df5af8"
}
Response examples (404)
{
  "message": "Something went wrong."
}
Response examples (409)
{
  "message": "Something went wrong."
}
Response examples (409)
{
  "message": "Something went wrong."
}
Response examples (500)
{
  "message": "Something went wrong."
}
Response examples (500)
{
  "message": "Something went wrong."
}