---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Sandbox shapes"
description: "The `sandbox_shapes` collection of Sylphx Sandboxes: A Shape is one entry of the platform's machine catalog: OS, size, the cell capability it needs, and its lease bounds."
type: reference
product: sandboxes
summary: "A Shape is one entry of the platform's machine catalog: OS, size, the cell capability it needs, and its lease bounds."
updated: 2026-09-28
order: 900
---

A Shape is one entry of the platform's machine catalog: OS, size, the cell capability it needs, and its lease bounds. The catalog is read-only; adding a shape is a Release of the catalog.

**Service** Sylphx Sandboxes · **Resource type** `sandboxes.sylphx.com/Shape` · **Name pattern** `sandbox_shapes/{shape}` · **Shape** `record`

## Fields

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

## 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/sandbox_shapes#get) | Gets a shape. |
| `GET` | [`list`](/docs/api/sandbox_shapes#list) | Lists shapes. |

## get

Gets a shape.

`GET https://api.sylphx.com/v1/sandbox_shapes/shape` · scope `sandboxes:read` · effect `read` · [Request, response and examples](/docs/api/sandbox_shapes/get)

## list

Lists shapes.

`GET https://api.sylphx.com/v1/sandbox_shapes` · scope `sandboxes:read` · effect `read` · paginated · [Request, response and examples](/docs/api/sandbox_shapes/list)
