---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create a snapshot"
description: "`sandboxes.snapshots.create` (POST /v1/{parent}/snapshots): Captures a running lease's disk as a snapshot."
type: reference
product: sandboxes
summary: "Captures a running lease's disk as a snapshot."
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.

Captures a running lease's disk as a snapshot.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots`
- **Scope** `sandboxes:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [snapshots](/docs/api/snapshots)
- **Query** `snapshot_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `snapshot` | `Snapshot` | The snapshot to create; only spec and caller-writable metadata are read. Required. |
| `snapshot_id` | `string` | The id segment of the name; the server assigns one when unset. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### Snapshot

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/snapshots/{snapshot}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SnapshotSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `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. |

### SnapshotSpec

| Field | Type | What it is |
| --- | --- | --- |
| `source_lease` | `string` | The running lease to capture. Required. |
| `include_memory` | `bool` | Capture process memory too. Refused UNIMPLEMENTED until the microVM runtime exposes memory snapshots. |
| `retention` | `duration` | Delete the snapshot after this long; default 7 days, at most 30 days. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/snapshots/{snapshot}`. |
| `uid` | `string` | `snp_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `SnapshotSpec` | Desired state. Required. |
| `status` | `SnapshotStatus` | 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. |

### SnapshotSpec

| Field | Type | What it is |
| --- | --- | --- |
| `source_lease` | `string` | The running lease to capture. Required. |
| `include_memory` | `bool` | Capture process memory too. Refused UNIMPLEMENTED until the microVM runtime exposes memory snapshots. |
| `retention` | `duration` | Delete the snapshot after this long; default 7 days, at most 30 days. |

### SnapshotStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `state` | `SnapshotState` | The state machine. Output only. One of `creating`, `ready`, `failed`, `deleting`. |
| `shape` | `string` | The source lease's shape. Output only. |
| `image` | `string` | The source lease's image, by digest. Output only. |
| `kind` | `LeaseKind` | The source lease's kind. Output only. One of `general`, `browser`, `desktop`, `android`. |
| `size_bytes` | `int64` | Captured bytes. Output only. |
| `expire_time` | `timestamp` | When the snapshot is deleted. Output only. |

### 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.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`INVALID_STATE`](/docs/api/errors/INVALID_STATE) — The Resource is in a state that forbids the call.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`RESOURCE_NOT_FOUND`](/docs/api/errors/RESOURCE_NOT_FOUND) — The named Resource does not exist or is not visible.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.
- [`UNIMPLEMENTED`](/docs/api/errors/UNIMPLEMENTED) — The path or method is not served (yet) at this version.

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

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"source_lease":"…"}}'
```

**TypeScript**

```ts
const response = await sylphx.sandboxes.snapshots.create({ parent: 'orgs/acme/projects/shop/envs/production', snapshot: { spec: { sourceLease: '…' } } })
```

**Rust**

```rust
let mut req = sylphx::sandboxes::CreateSnapshotRequest::default();
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
req.snapshot = Some(sylphx::sandboxes::Snapshot {
    spec: Some(sylphx::sandboxes::SnapshotSpec {
        source_lease: "…".to_string(),
        ..Default::default()
    }),
    ..Default::default()
});
let response = sx.sandboxes().snapshots().create(req).await?;
```

**CLI**

```bash
sylphx sandboxes snapshots create --parent orgs/acme/projects/shop/envs/production --spec.source-lease …
```

**MCP**

```json
{ "method_id": "sandboxes.snapshots.create", "args": {"parent":"orgs/acme/projects/shop/envs/production","snapshot":{"spec":{"source_lease":"…"}}} }
```