v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB

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

network_idstring uuid required

The network this entity belongs to.

Snapshot created

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.7"
  }
}