---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Get a pool"
description: "`sandboxes.pools.get` (GET /v1/{name}): Gets a pool."
type: reference
product: sandboxes
summary: "Gets a pool."
updated: 2026-09-28
nav: false
---

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

Gets a pool.

- **Path** `GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool`
- **Scope** `sandboxes:read`
- **Effect** `read` — nothing is written.
- **Collection** [pools](/docs/api/pools)

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | The name of the pool to get. Required. |

## Response

| 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`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/pools/pool" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.sandboxes.pools.get({ name: 'orgs/acme/projects/shop/envs/production/pools/pool' })
```

**Rust**

```rust
let mut req = sylphx::sandboxes::GetPoolRequest::default();
req.name = "orgs/acme/projects/shop/envs/production/pools/pool".to_string();
let response = sx.sandboxes().pools().get(req).await?;
```

**CLI**

```bash
sylphx sandboxes pools get orgs/acme/projects/shop/envs/production/pools/pool
```

**Terraform**

```hcl
data "sylphx_sandboxes_pool" "pool" {
  name = "orgs/acme/projects/shop/envs/production/pools/pool"
}
```

**MCP**

```json
{ "method_id": "sandboxes.pools.get", "args": {"name":"orgs/acme/projects/shop/envs/production/pools/pool"} }
```