---
title: "Get snapshot details"
method: GET
path: "/snapshots/{snapshotId}"
---

# Get snapshot details

`GET /snapshots/{snapshotId}`

## Path parameters

- `snapshotId` string, required

## Response `200`

Snapshot details

- Snapshot
  - `id` string, required — Auto-generated unique snapshot identifier
  - `name` string, nullable — Optional human-readable snapshot name (unique per source instance)
  - `kind` 'Standby' | 'Stopped', required — Snapshot capture kind
  - `tags` Tags — User-defined key-value tags.
  - `source_instance_id` string, required — Source instance ID at snapshot creation time
  - `source_instance_name` string, required — Source instance name at snapshot creation time
  - `source_hypervisor` 'cloud-hypervisor' | 'firecracker' | 'qemu' | 'vz', required — Source instance hypervisor at snapshot creation time
  - `created_at` string, date-time, required — Snapshot creation timestamp
  - `size_bytes` integer, required — Total payload size in bytes
  - `compression_state` 'none' | 'compressing' | 'compressed' | 'error' — Compression status of the snapshot payload memory file
  - `compression_error` string, nullable — Compression error message when compression_state is error
  - `compression` SnapshotCompressionConfig
    - `enabled` boolean, required — Enable snapshot memory compression
    - `algorithm` 'zstd' | 'lz4' — Compression algorithm (defaults to zstd when enabled). Ignored when enabled is false.
    - `level` integer — Compression level. Allowed ranges are zstd=1-19 and lz4=0-9. When omitted, zstd defaults to 1 and lz4 defaults to 0. Ignored when enabled is false.
  - `compressed_size_bytes` integer, nullable — Compressed memory payload size in bytes
  - `uncompressed_size_bytes` integer, nullable — Uncompressed memory payload size in bytes

## Other responses

- `404` — Snapshot not found
- `500` — Internal server error

---

[API](https://skmtc.net/kernel/apis/hypeman-api.md) · [All operations](https://skmtc.net/kernel/apis/hypeman-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kernel/hypeman-api/versions/b4642bb950dc/schema)
