Skip to content
Console
On this page

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.com does 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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/pools/{pool}.
uidstringpol_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specPoolSpecDesired state. Required.
statusPoolStatusObserved 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.

MethodCallWhat it does
GETgetGets a pool.
GETlistLists pools in a environment.
POSTcreateCreates a pool. The Operation is done when the controller settles it.
PATCHupdateUpdates a pool.
DELETEdeleteDeletes 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