---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Pools"
description: "The `pools` collection of Sylphx Sandboxes: A Pool keeps never-leased machines of one shape and image warm, so a lease starts in seconds."
type: reference
product: sandboxes
summary: "A Pool keeps never-leased machines of one shape and image warm, so a lease starts in seconds."
updated: 2026-09-28
order: 900
---

> **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

| 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`](/docs/api/pools#get) | Gets a pool. |
| `GET` | [`list`](/docs/api/pools#list) | Lists pools in a environment. |
| `POST` | [`create`](/docs/api/pools#create) | Creates a pool. The Operation is done when the controller settles it. |
| `PATCH` | [`update`](/docs/api/pools#update) | Updates a pool. |
| `DELETE` | [`delete`](/docs/api/pools#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](/docs/api/pools/get)

## 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](/docs/api/pools/list)

## 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](/docs/api/pools/create)

## 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](/docs/api/pools/update)

## 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](/docs/api/pools/delete)