Volumes
A Volume is a persistent disk scoped to one environment, encrypted at rest unless its class is `local`, attached by name when a lease is…
A Volume is a persistent disk scoped to one environment, encrypted at rest unless its class is local, 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 | Gets a volume. |
GET | list | Lists volumes in a environment. |
POST | create | Creates a volume. |
PATCH | update | Updates a volume: grows spec.size_gib and edits metadata. |
POST | archive | 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. |
DELETE | 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
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
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
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
archive
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.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume:archive · scope sandboxes:write · effect write · validate_only · Request, response and examples
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