---
# @generated by sylphx-gen. Do not edit.
title: "Archive a volume"
description: "`sandboxes.volumes.archive` (POST /v1/{name}:archive): Archives an idle standard workspace without changing its identity or destroying its files."
type: reference
product: sandboxes
summary: "Archives an idle standard workspace without changing its identity or destroying its files."
updated: 2026-09-28
nav: false
---

Archives an idle standard workspace without changing its identity or destroying its files. Ordinary attachment restores the retained copy. Validation reports eligibility and copy coverage without changing state.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume:archive`
- **Scope** `sandboxes:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [volumes](/docs/api/volumes)
- **Validate-only** `validate_only=true` runs every check and writes nothing

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The workspace to archive. Its name and UID remain unchanged. Required. |
| `etag` | `string` | Archive only if the current etag matches. |
| `validate_only` | `bool` | Check eligibility and retained-copy evidence without modifying the Volume, creating archive objects, or releasing its source claim. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `volume` | `Volume` | The current workspace, including its unchanged resource identity. |
| `reclaimable` | `bool` | Whether this attempt passed the eligibility and retained-copy checks. Validation is an observation; execution always checks current state again. |
| `requested_bytes` | `int64` | Requested PVC bytes that archival would release, not physical storage use. |
| `archived` | `bool` | True only after the source claim has disappeared and its archive is retained. |
| `reason` | `string` | A bounded decision reason, such as within_grace, attached, awaiting_offsite_coverage, coverage_unavailable, pending or archived. |

### Volume

| 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. A `local` volume never grows. Required. |
| `storage_class` | `string` | The storage class; unset means `standard`. `standard`: replicated network storage, encrypted at rest with its own key, attachable on any node. `local`: fast node-local storage, not replicated, for warm build workspaces. The guest gets it as an ext4 filesystem it formats on first use. It pins every lease that attaches it to its node, is not encrypted at rest, cannot grow, cannot be mounted read-only, and is lost with its node: keep only caches on it. |
| `region` | `string` | The region whose Cell holds the volume; default the project's home region. A lease mounts the volume only in the same region. |

### 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` | Whether the volume is encrypted at rest with its own key: true for `standard`, false for `local`. 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.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`ETAG_MISMATCH`](/docs/api/errors/ETAG_MISMATCH) — The etag sent does not match the Resource's current etag.

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

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume:archive" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

**TypeScript**

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

**Rust**

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

**CLI**

```bash
sylphx sandboxes volumes archive orgs/acme/projects/shop/envs/production/volumes/volume
```

**MCP**

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