Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Pools
A Pool keeps never-leased machines of one shape and image warm, so a lease starts in seconds.
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.
A Pool keeps never-leased machines of one shape and image warm, so a lease starts in seconds. An empty pool makes a lease slower, never different.
Service Sylphx Sandboxes · Resource type sandboxes.sylphx.com/Pool · Name pattern orgs/{org}/projects/{project}/envs/{env}/pools/{pool} · Shape spec_status
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/pools/{pool}. |
uid | string | pol_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | PoolSpec | Desired state. Required. |
status | PoolStatus | 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 pool. |
GET | list | Lists pools in a environment. |
POST | create | Creates a pool. The Operation is done when the controller settles it. |
PATCH | update | Updates a pool. |
DELETE | delete | Deletes a pool. |
#get
Gets a pool.
GET 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.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools · scope sandboxes:read · effect read · paginated · Request, response and examples
#create
Creates a pool. The Operation is done when the controller settles it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools · scope sandboxes:write · effect write · long-running · Request, response and examples
#update
Updates a pool.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool · scope sandboxes:write · effect write · long-running · Request, response and examples
#delete
Deletes a pool.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool · scope sandboxes:write · effect destructive · long-running · Request, response and examples