---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Delete a volume"
description: "`sandboxes.volumes.delete` (DELETE /v1/{name}): Deletes a volume and destroys its data."
type: reference
product: sandboxes
summary: "Deletes a volume and destroys its data."
updated: 2026-09-28
nav: false
---

Deletes a volume and destroys its data. Refused RESOURCE_IN_USE while it is attached.

- **Path** `DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume`
- **Scope** `sandboxes:write`
- **Effect** `destructive` — a successful call removes data; the CLI asks before it runs.
- **Collection** [volumes](/docs/api/volumes)
- **Query** `etag`, `allow_missing`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the volume to delete. Required. |
| `etag` | `string` | Delete only if the current etag matches. |
| `allow_missing` | `bool` | Succeed when the Resource does not exist. |
| `validate_only` | `bool` | Validate without deleting anything. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/volumes/{volume}`. |
| `uid` | `string` | `vol_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `VolumeSpec` | Desired state. Required. |
| `status` | `VolumeStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### VolumeSpec

| Field | Type | What it is |
| --- | --- | --- |
| `size_gib` | `int32` | Size in GiB, 1 to 1024; it may grow and never shrink. Required. |

### VolumeStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `VolumeState` | The state machine. Output only. One of `creating`, `available`, `attached`, `deleting`, `failed`. |
| `attached_lease` | `string` | The lease the volume is attached to. Output only. |
| `attached_generation` | `int64` | The generation of `attached_lease` that holds the write fence. Output only. |
| `encrypted` | `bool` | Always true: every volume is encrypted at rest with its own key. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.
- [`RESOURCE_IN_USE`](/docs/api/errors/RESOURCE_IN_USE) — The Resource is attached to or held by another Resource, for example a volume attached to a running lease.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X DELETE "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.sandboxes.volumes.delete({ name: 'orgs/acme/projects/shop/envs/production/volumes/volume' })
```

**Rust**

```rust
let mut req = sylphx::sandboxes::DeleteVolumeRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/volumes/volume".to_string();
let response = sx.sandboxes().volumes().delete(req).await?;
```

**CLI**

```bash
sylphx sandboxes volumes delete orgs/acme/projects/shop/envs/production/volumes/volume --yes
```

**MCP**

```json
{ "method_id": "sandboxes.volumes.delete", "args": {"name":"orgs/acme/projects/shop/envs/production/volumes/volume"} }
```
