Console

Start

Agents

App store purchases

Auth

Builds

Credits

Database

Flags

Generated Assets

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Queues

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Volume
ResourceMeta
VolumeSpec
Response
ResourceMeta
VolumeSpec
VolumeStatus
Condition
Errors
Examples

Reference

Create a volume

Creates a volume.

Checked 2026-09-28

Creates a volume.

Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/volumes
Scope sandboxes:write
Effect write — a successful call changes state.
Collection volumes
Query volume_id, validate_only

#Request

Field	Type	What it is
`parent`	`string`	The parent to create in. Required.
`volume`	`Volume`	The volume to create; only spec and caller-writable metadata are read. Required.
`volume_id`	`string`	The id segment of the name; the server assigns one when unset.
`validate_only`	`bool`	Validate and return the result without writing anything.

#Volume

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/volumes/{volume}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`VolumeSpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`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.

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

#Response

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.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
RESOURCE_ALREADY_EXISTS — A Resource with this name exists.
IDEMPOTENCY_KEY_REUSED — An Idempotency-Key was reused with another body.
IDEMPOTENCY_IN_PROGRESS — The first call with this Idempotency-Key is still running.
PLAN_LIMIT_REACHED — The plan's limit is reached.

Every error arrives in the body Errors describes.

#Examples

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

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links