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 pools
Every sylphx sandboxes pools command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
The pools commands of Sylphx Sandboxes, as the CLI spells them: the same
calls as the pools API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a pool.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes pools get orgs/acme/projects/shop/envs/production/pools/poolGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool · scope sandboxes:read · effect read · Request, response and examples
#list
Lists pools 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 pools list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools · 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 pool. The Operation is done when the controller settles it.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx sandboxes pools create --parent orgs/acme/projects/shop/envs/production --spec.shape … --spec.image …POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools · 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.shape | string | The shape. Required. |
--spec.image | string | The image: an artifact in Sylphx Artifacts, by digest, or template:<name>. Required. |
--spec.warm.min | int | Warm machines kept booted. |
--spec.warm.max | int | Warm machines at most; at most 10 on free and 100 on Pro. |
--spec.max-age | duration | Warm machines older than this are recycled; 5 minutes to 2 hours. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
#update
Updates a pool.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes pools update orgs/acme/projects/shop/envs/production/pools/pool --spec.image …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool · 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.image | string | The image: an artifact in Sylphx Artifacts, by digest, or template:<name>. Required. |
--spec.warm.min | int | Warm machines kept booted. |
--spec.warm.max | int | Warm machines at most; at most 10 on free and 100 on Pro. |
--spec.max-age | duration | Warm machines older than this are recycled; 5 minutes to 2 hours. |
--allow-missing | bool | Create the Resource when it does not exist (declarative upsert). |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
#delete
Deletes a pool.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx sandboxes pools delete orgs/acme/projects/shop/envs/production/pools/pool --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool · 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). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
--yes | bool | Do not ask before this destructive call. |