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

Gets a shape.

- **Path** `GET https://api.sylphx.com/v1/sandbox_shapes/shape`
- **Scope** `sandboxes:read`
- **Effect** `read` — nothing is written.
- **Collection** [sandbox_shapes](/docs/api/sandbox_shapes)

## Request

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

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `sandbox_shapes/{shape}`. |
| `uid` | `string` | `shp_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `os` | `ShapeOs` | The operating system. Output only. One of `linux`, `macos`. |
| `vcpu_count` | `int32` | vCPUs; for a whole host, its cores. Output only. |
| `memory_mib` | `int32` | Memory in MiB. Output only. |
| `disk_gib` | `int32` | Disk in GiB. Output only. |
| `capability` | `string` | The cell capability Placement matches, for example `kata` or `macos`. Output only. |
| `min_lease_duration` | `duration` | The shortest lease; 24 hours for macOS. Output only. |
| `max_lease_duration` | `duration` | The longest lease. Output only. |
| `offered` | `bool` | Whether the shape is sold now. A lease of an unsold shape is refused SHAPE_NOT_OFFERED. Output only. |
| `price_micros_per_second` | `int64` | The list price of one second of this shape, in millionths of a US dollar; 0 for a class that is not priced. `spec.budget.max_cost_micros` is measured against it; the invoice is Sylphx Billing's. Output only. |
| `kinds` | `LeaseKind[]` | The lease kinds this shape can serve. Output only. One of `general`, `browser`, `desktop`, `android`. |

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

## 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/sandbox_shapes/shape" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"
```

**TypeScript**

```ts
const response = await sylphx.sandboxes.sandboxShapes.get({ name: 'sandbox_shapes/shape' })
```

**Rust**

```rust
let mut req = sylphx::sandboxes::GetShapeRequest::default();
req.name = "sandbox_shapes/shape".to_string();
let response = sx.sandboxes().sandbox_shapes().get(req).await?;
```

**CLI**

```bash
sylphx sandboxes sandbox-shapes get sandbox_shapes/shape
```

**MCP**

```json
{ "method_id": "sandboxes.sandbox_shapes.get", "args": {"name":"sandbox_shapes/shape"} }
```