Remove a volume Run in API Explorer

DELETE /volumes/{name}

Instruct the driver to remove the volume.

Path parameters

  • name string Required

    Volume name or ID

Query parameters

  • force boolean

    Force the removal of the volume

    Default value is false.

Responses

  • 204

    The volume was removed

  • 404 application/json

    No such volume or volume driver

    Hide response attribute Show response attribute object
    • message string Required

      The error message.

  • 409 application/json

    Volume is in use and cannot be removed

    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.

DELETE /volumes/{name}
curl \
 --request DELETE 'http://api.example.com/v1.49/volumes/{name}'
Response examples (404)
{
  "message": "Something went wrong."
}
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."
}