Skip to content
Console
On this page

Sandbox shapes

A Shape is one entry of the platform's machine catalog: OS, size, the cell capability it needs, and its lease bounds.

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

FieldTypeWhat it is
namestringsandbox_shapes/{shape}.
uidstringshp_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
osShapeOsThe operating system. Output only. One of linux, macos.
vcpu_countint32vCPUs; for a whole host, its cores. Output only.
memory_mibint32Memory in MiB. Output only.
disk_gibint32Disk in GiB. Output only.
capabilitystringThe cell capability Placement matches, for example kata or macos. Output only.
min_lease_durationdurationThe shortest lease; 24 hours for macOS. Output only.
max_lease_durationdurationThe longest lease. Output only.
offeredboolWhether the shape is sold now. A lease of an unsold shape is refused SHAPE_NOT_OFFERED. Output only.
price_micros_per_secondint64The 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.
kindsLeaseKind[]The lease kinds this shape can serve. Output only. One of general, browser, desktop, android, ios.
simulatorSimulatorRuntimeThe offered Simulator toolchain; present only on an iOS shape. 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.

MethodCallWhat it does
GETgetGets a shape.
GETlistLists shapes.

get

Gets a shape.

GET https://api.sylphx.com/v1/sandbox_shapes/shape · scope sandboxes:read · effect read · Request, response and examples

list

Lists shapes.

GET https://api.sylphx.com/v1/sandbox_shapes · scope sandboxes:read · effect read · paginated · Request, response and examples