Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx sandboxes volumes
Every sylphx sandboxes volumes command: its argument, its flags and a run line.
The volumes commands of Sylphx Sandboxes, as the CLI spells them: the same
calls as the volumes API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a volume.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes volumes get orgs/acme/projects/shop/envs/production/volumes/volumeGET 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.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx sandboxes volumes list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes · scope sandboxes:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels, filterable fields, and Ready. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Creates a volume.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx sandboxes volumes create --parent orgs/acme/projects/shop/envs/production --spec.size-gib 1POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes · scope sandboxes:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.size-gib | int | Size in GiB, 1 to 1024; it may grow and never shrink. A local volume never grows. Required. |
--spec.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. |
--spec.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. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a volume: grows spec.size_gib and edits metadata.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes volumes update orgs/acme/projects/shop/envs/production/volumes/volume --spec.size-gib 1PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume · scope sandboxes:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.size-gib | int | Size in GiB, 1 to 1024; it may grow and never shrink. A local volume never grows. Required. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a volume and destroys its data. Refused RESOURCE_IN_USE while it is attached.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes volumes delete orgs/acme/projects/shop/envs/production/volumes/volume --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes/volume · scope sandboxes:write · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--allow-missing | bool | Succeed when the Resource does not exist. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--yes | bool | Do not ask before this destructive call. |