---
title: "Take a snapshot of the current live topology + entity state for a network.
Acquires the discovery snapshot lock, creates the snapshots row, runs
close-and-clone to stamp every Snapshotable entity row with `snapshot_id`
and close them. The topology subscriber inserts the snapshot's topology
row off the back of the `Snapshot::Created` event."
method: POST
path: "/api/v1/snapshots"
tags: ["Snapshots"]
---

# Take a snapshot of the current live topology + entity state for a network.
Acquires the discovery snapshot lock, creates the snapshots row, runs
close-and-clone to stamp every Snapshotable entity row with `snapshot_id`
and close them. The topology subscriber inserts the snapshot's topology
row off the back of the `Snapshot::Created` event.

`POST /api/v1/snapshots`

## Request body

- CreateSnapshotRequest
  - `network_id` string, uuid, required — The network this entity belongs to.

## Response `200`

Snapshot created

- ApiResponseSnapshot
  - `data` object — The result payload. Omitted on failure.
    - `created_by_user_id` string, uuid, nullable — User who took the snapshot.
    - `network_id` string, uuid, required — The network this entity belongs to.
    - `taken_at` string, date-time, required — The point in time this snapshot captures.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

## Other responses

- `402` — Snapshots not available on plan
- `409` — Network is busy with discovery; retry shortly

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)