---
# @generated by sylphx-gen. Do not edit.
title: "sylphx sandboxes snapshots"
description: "The sylphx sandboxes snapshots commands of Sylphx Sandboxes: every verb, with its argument, its flags and a run line."
type: reference
product: sandboxes
summary: "Every sylphx sandboxes snapshots command: its argument, its flags and a run line."
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.

The `snapshots` commands of Sylphx Sandboxes, as the CLI spells them: the same
calls as [the `snapshots` API page](/docs/api/snapshots), typed for the
shell. [Install, sign in and the grammar](/docs/cli) are on the CLI index.

## get

Gets a snapshot.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx sandboxes snapshots get orgs/acme/projects/shop/envs/production/snapshots/snapshot
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots/snapshot` · scope `sandboxes:read` · effect `read` · [Request, response and examples](/docs/api/snapshots/get)

## list

Lists snapshots in a environment.

**`PARENT`** — optional: the CLI fills it from the linked project or the
key's scope when it is left out.

**CLI**

```bash
sylphx sandboxes snapshots list orgs/acme/projects/shop/envs/production
```

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots` · scope `sandboxes:read` · effect `read` · [Request, response and examples](/docs/api/snapshots/list)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--page-size` | `int` | At most this many; default 50, clamped to 1000. |
| `--page-token` | `string` | `next_page_token` of the previous page. |
| `--filter` | `string` | AIP-160 filter over labels, filterable fields, and Ready. |
| `--order-by` | `string` | AIP-132 ordering over filterable fields. |

## create

Captures a running lease's disk as a snapshot.

**`ID`** — The id segment of the new Resource's name; the server assigns one when omitted.

**CLI**

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

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots` · scope `sandboxes:write` · effect `write` · [Request, response and examples](/docs/api/snapshots/create)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--parent` | `string` | The parent to create in; defaults to the linked project or the key's scope. |
| `--meta.labels` | `key=value` | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
| `--meta.annotations` | `key=value` | Caller-writable, unindexed annotations. Repeat the flag for each value. |
| `--meta.display-name` | `string` | Caller-writable human-readable name. |
| `--spec.source-lease` | `string` | The running lease to capture. Required. |
| `--spec.include-memory` | `bool` | Capture process memory too. Refused UNIMPLEMENTED until the microVM runtime exposes memory snapshots. |
| `--spec.retention` | `duration` | Delete the snapshot after this long; default 7 days, at most 30 days. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |

## delete

Deletes a snapshot.

**`NAME`** — the resource's name; a bare id is enough below the linked
project.

**CLI**

```bash
sylphx sandboxes snapshots delete orgs/acme/projects/shop/envs/production/snapshots/snapshot --yes
```

`DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/snapshots/snapshot` · scope `sandboxes:write` · effect `destructive` · [Request, response and examples](/docs/api/snapshots/delete)

**Flags**

| Flag | Type | What it does |
| --- | --- | --- |
| `--etag` | `string` | Delete only if the current etag matches. |
| `--allow-missing` | `bool` | Succeed when the Resource does not exist. |
| `--dry-run` | `bool` | Validate and print the result without writing (validate_only). |
| `--yes` | `bool` | Do not ask before this destructive call. |