---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Volumes"
description: "The `volumes` collection of Sylphx Sandboxes: A Volume is a persistent disk scoped to one environment, encrypted at rest, attached by name when a lease is created."
type: reference
product: sandboxes
summary: "A Volume is a persistent disk scoped to one environment, encrypted at rest, attached by name when a lease is created."
updated: 2026-09-28
order: 900
---

A Volume is a persistent disk scoped to one environment, encrypted at rest, attached by name when a lease is created. It has one writer: the lease it is attached to, fenced by that lease's generation. It survives the lease's end and is destroyed only by Delete.

**Service** Sylphx Sandboxes · **Resource type** `sandboxes.sylphx.com/Volume` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/volumes/{volume}` · **Shape** `spec_status`

## Fields

| 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. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/volumes#get) | Gets a volume. |
| `GET` | [`list`](/docs/api/volumes#list) | Lists volumes in a environment. |
| `POST` | [`create`](/docs/api/volumes#create) | Creates a volume. |
| `PATCH` | [`update`](/docs/api/volumes#update) | Updates a volume: grows `spec.size_gib` and edits metadata. |
| `DELETE` | [`delete`](/docs/api/volumes#delete) | Deletes a volume and destroys its data. Refused RESOURCE_IN_USE while it is attached. |

## get

Gets a volume.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume` · scope `sandboxes:read` · effect `read` · [Request, response and examples](/docs/api/volumes/get)

## list

Lists volumes in a environment.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes` · scope `sandboxes:read` · effect `read` · paginated · [Request, response and examples](/docs/api/volumes/list)

## create

Creates a volume.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes` · scope `sandboxes:write` · effect `write` · [Request, response and examples](/docs/api/volumes/create)

## update

Updates a volume: grows `spec.size_gib` and edits metadata.

`PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume` · scope `sandboxes:write` · effect `write` · [Request, response and examples](/docs/api/volumes/update)

## delete

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

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume` · scope `sandboxes:write` · effect `destructive` · [Request, response and examples](/docs/api/volumes/delete)