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
List pools
Lists pools in a environment.
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.
Lists pools in a environment.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools - Scope
sandboxes:read - Effect
read— nothing is written. - Collection pools
- Query
page_size,page_token,filter,order_by - Pagination the answer carries
poolsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | 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. |
#Response
| Field | Type | What it is |
|---|---|---|
pools | Pool[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#Pool
| 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. |
#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. |
#PoolSpec
| Field | Type | What it is |
|---|---|---|
shape | string | The shape. Required. |
image | string | The image: an artifact in Sylphx Artifacts, by digest, or template:<name>. Required. |
warm | PoolWarm | Warm machine bounds. Required. |
max_age | duration | Warm machines older than this are recycled; 5 minutes to 2 hours. |
#PoolStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
warm_machines | int32 | Booted, never-leased machines ready now. Output only. |
booting_machines | int32 | Machines booting into the pool. Output only. |
#PoolWarm
| Field | Type | What it is |
|---|---|---|
min | int32 | Warm machines kept booted. |
max | int32 | Warm machines at most; at most 10 on free and 100 on Pro. |
#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.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools" \
-H "Authorization: Bearer $SYLPHX_API_KEY"