Snapshots
List snapshots
Authorization<token>
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
site_id?|
Filter by site ID
ids?array<>|
Filter by specific entity IDs (for selective loading)
limit?|
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
offset?|
Number of results to skip. Default: 0.
Response Body
application/json
curl -X GET "https://example.com/api/v1/snapshots"{
"data": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811",
"taken_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"created_by_user_id": "209f54c4-4c33-43bc-9c6a-ef4c65ad7473"
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.19.6"
},
"success": true,
"error": "string"
}Product names and logos are trademarks of their respective owners. See credits.
Get snapshot by ID
Previous Page
Create snapshot
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.