---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Snapshots"
description: "The `snapshots` collection of Sylphx Sandboxes: A Snapshot is a lease's disk and image captured at one moment."
type: reference
product: sandboxes
summary: "A Snapshot is a lease's disk and image captured at one moment."
updated: 2026-09-28
order: 900
---

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

A Snapshot is a lease's disk and image captured at one moment. A lease created with `source_snapshot` boots from it. Process memory is not captured.

**Service** Sylphx Sandboxes · **Resource type** `sandboxes.sylphx.com/Snapshot` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/snapshots/{snapshot}` · **Shape** `spec_status`

## Fields

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

## 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/snapshots#get) | Gets a snapshot. |
| `GET` | [`list`](/docs/api/snapshots#list) | Lists snapshots in a environment. |
| `POST` | [`create`](/docs/api/snapshots#create) | Captures a running lease's disk as a snapshot. |
| `DELETE` | [`delete`](/docs/api/snapshots#delete) | Deletes a snapshot. |

## get

Gets a 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.

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

## create

Captures a running lease's disk as a snapshot.

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

## delete

Deletes a snapshot.

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