Snapshots
Trigger and download diagnostic HTML reports of deployment nodes via the Supervisor API.
Set variables to auto-fill all examples and run requests in-browser.
Snapshots are diagnostic reports of a deployment's nodes. Each snapshot runs 30+ checks on the host - operating system, runtimes, certificates, network, kernel parameters, recent logs - and packages the results as a self-contained interactive HTML report. Optionally bundles a ZIP of the Iggy data directory for offline inspection.
Snapshots are not data backups. They do not protect against data loss; they help you understand what is going on inside a node when something looks wrong. For point-in-time recovery use Backups.
All endpoints use the Supervisor API ({supervisor_url}).
Required permission: deployment:read to list and download, deployment:manage to create or delete.
processingcompletedAvailable on all plans. Per-deployment count and retention follow plan limits (Basic: 3 / 7 days, Pro: 5 / 14 days, Enterprise: 20 / 90 days).
Create a Snapshot
POST{supervisor_url}/deployments/{deployment_id}/snapshotsTrigger a diagnostic snapshot on every node. Only one snapshot can be in progress per deployment at a time.
curl -X POST {supervisor_url}/deployments/{deployment_id}/snapshots \
-H "ld-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"redact_secrets": true,
"include_iggy": true
}'| Field | Default | Description |
|---|---|---|
redact_secrets | true | Mask passwords, keys, and tokens in the report |
include_iggy | true | Bundle the Iggy data directory state as a separate ZIP |
Returns 204 No Content. The snapshot transitions from processing to completed once every node finishes.
List Snapshots
GET{supervisor_url}/deployments/{deployment_id}/snapshotsList all snapshots for the deployment, paginated by node.
curl "{supervisor_url}/deployments/{deployment_id}/snapshots?page=1&results=10" \
-H "ld-api-key: YOUR_API_KEY"{
"items": [
{
"id": 1,
"tenant_id": 615380456123456789,
"division_id": 1,
"environment_id": 1,
"deployment_id": 611298765432109056,
"node_id": 610809900976570889,
"deployment_name": "events-prod",
"name": "snapshot-20260601-103000",
"status": "completed",
"created_at": "2026-06-01T10:30:00Z",
"completed_at": "2026-06-01T10:31:00Z"
}
],
"page": 1,
"total_results": 1,
"total_pages": 1
}Download a Snapshot
GET{supervisor_url}/deployments/{deployment_id}/snapshots/{snapshot_id}/downloadRetrieve a presigned URL for the snapshot ZIP containing the interactive HTML report and the optional Iggy data bundle.
curl {supervisor_url}/deployments/{deployment_id}/snapshots/{snapshot_id}/download \
-H "ld-api-key: YOUR_API_KEY"{
"url": "https://storage.example.com/snapshots/...?signature=..."
}The presigned URL is short-lived. Download the archive promptly.
Delete a Snapshot
DELETE{supervisor_url}/deployments/{deployment_id}/snapshots/{snapshot_id}Delete a snapshot and its stored archive.
curl -X DELETE {supervisor_url}/deployments/{deployment_id}/snapshots/{snapshot_id} \
-H "ld-api-key: YOUR_API_KEY"Returns 204 No Content.