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
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
List volumes
Lists volumes in a environment.
Lists volumes in a environment.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes - Scope
sandboxes:read - Effect
read— nothing is written. - Collection volumes
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
volumesand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | 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. |
#Response
| Field | Type | What it is |
|---|---|---|
volumes | Volume[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#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— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes" \
-H "Authorization: Bearer $SYLPHX_API_KEY"