Experimental
DeleteVolume deletes a volume; deleting an already absent volume succeeds.
DELETE
/v1/volumes/{volume} DeleteVolume deletes a volume; deleting an already absent volume succeeds.
Returns unimplemented when this operation is unavailable. Support does not grant permission.
Connection and access
API connection and authentication guidance
https://connect.docker.com/sandboxes
—
The API base URL. Append the /v1 paths while preserving this URL's path prefix.
Use one of these alternatives. Requirements within an alternative apply together.
bearer
Parameters
volume
path
Required
The volume id.
Type:
string
All schema constraints and annotations
{
"type": "string"
}If-Match
header
Required
The complete quoted strong entity-tag observed on the resource, including its quotes. Every mutation of an existing resource requires it: an absent value answers 428 and a stale one 412, each carrying failedPrecondition in the body.
Type:
string
etag is the required precondition, the value the target's last read returned.
An absent one refuses etag_required and a stale one etag_mismatch.
All schema constraints and annotations
{
"description": "etag is the required precondition, the value the target's last read returned.\nAn absent one refuses etag_required and a stale one etag_mismatch.",
"title": "If-Match",
"type": "string"
}Request and responses
Response
204
Success. The response carries no body.
No response content is declared.
Response
412
The precondition is not the resource's current etag. The body carries failedPrecondition naming etag_mismatch and an EtagMismatch detail with the current value.
application/json
Schema:
Error
etag_mismatch
{
"code": "failedPrecondition",
"details": [
{
"@type": "type.googleapis.com/docker.sandboxes.v1.EtagMismatch",
"currentEtag": "v2"
}
],
"message": "etag_mismatch: The precondition is not the resource's current etag. The body carries failedPrecondition naming etag_mismatch and an EtagMismatch detail with the current value."
}Response
428
No precondition was sent. The body carries failedPrecondition naming etag_required.
application/json
Schema:
Error
etag_required
{
"code": "failedPrecondition",
"message": "etag_required: No precondition was sent. The body carries failedPrecondition naming etag_required."
}Response
501
This operation is not available on this service.
application/json
Schema:
Error
unimplemented
{
"code": "unimplemented",
"message": "This operation is not available on this service."
}Response
default
The structured Error body identifies the failure with a stable code and optional typed details.
application/json
Schema:
Error
Schema example
{
"code": "notFound",
"details": [],
"message": "sandbox not found"
}Referenced schemas
Complete operation contract
{
"description": "DeleteVolume deletes a volume; deleting an already absent volume succeeds.\n\nReturns unimplemented when this operation is unavailable. Support does not grant permission.",
"operationId": "deleteVolume",
"parameters": [
{
"description": "The volume id.",
"in": "path",
"name": "volume",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The complete quoted strong entity-tag observed on the resource, including its quotes. Every mutation of an existing resource requires it: an absent value answers 428 and a stale one 412, each carrying failedPrecondition in the body.",
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"description": "etag is the required precondition, the value the target's last read returned.\nAn absent one refuses etag_required and a stale one etag_mismatch.",
"title": "If-Match",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success. The response carries no body."
},
"412": {
"content": {
"application/json": {
"examples": {
"etag_mismatch": {
"summary": "The precondition is not the resource's current etag. The body carries failedPrecondition naming etag_mismatch and an EtagMismatch detail with the current value.",
"value": {
"code": "failedPrecondition",
"details": [
{
"@type": "type.googleapis.com/docker.sandboxes.v1.EtagMismatch",
"currentEtag": "v2"
}
],
"message": "etag_mismatch: The precondition is not the resource's current etag. The body carries failedPrecondition naming etag_mismatch and an EtagMismatch detail with the current value."
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "The precondition is not the resource's current etag. The body carries failedPrecondition naming etag_mismatch and an EtagMismatch detail with the current value."
},
"428": {
"content": {
"application/json": {
"examples": {
"etag_required": {
"summary": "No precondition was sent. The body carries failedPrecondition naming etag_required.",
"value": {
"code": "failedPrecondition",
"message": "etag_required: No precondition was sent. The body carries failedPrecondition naming etag_required."
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "No precondition was sent. The body carries failedPrecondition naming etag_required."
},
"501": {
"content": {
"application/json": {
"examples": {
"unimplemented": {
"summary": "This operation is not available on this service.",
"value": {
"code": "unimplemented",
"message": "This operation is not available on this service."
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "This operation is not available on this service."
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "The structured Error body identifies the failure with a stable code and optional typed details."
}
},
"security": [
{
"bearer": []
}
],
"summary": "DeleteVolume deletes a volume; deleting an already absent volume succeeds.",
"tags": [
"Volumes"
],
"x-sbx-authenticated-only": false,
"x-sbx-conditional-permissions": [],
"x-sbx-error-responses": [
{
"code": "UNIMPLEMENTED",
"description": "This operation is not available on this service."
}
],
"x-sbx-plane": "control",
"x-sbx-required-permissions": [
"volumesWrite"
],
"x-sbx-serving-surface": "management"
}