SCscanopy
Snapshots

Create snapshot

Changed on

Takes a snapshot of the current live topology and entity state for a site. 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

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/snapshots
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

site_idstring uuid required

The site this entity belongs to.

Response

Snapshot created

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

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

Changes

  • a6ea2ab6fbb9Revision changes
    • breaking

      added the new required request property

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the request property

    • info

      added the required property ///// to the response with the status

  • d38c20597ec1Revision changes
    • info

      endpoint added