Skip to main content
Use this endpoint to permanently delete a snapshot template. The operation removes all snapshot files from disk and deletes the associated database record. This cannot be undone.
Deleting a snapshot that capsules depend on will prevent those capsules from being resumed. If any paused capsule was created from this template, resuming it after deletion will fail. Verify that no paused capsules rely on this snapshot before deleting it.

Endpoint

DELETE https://app.wrenn.dev/api/v1/snapshots/{name}

Authentication

X-API-Key
string
required
Your team’s API key. Pass the full wrn_... key value.

Path parameters

name
string
required
The name of the snapshot template to delete. This must exactly match the name field returned by GET /v1/snapshots.

Example request

curl -X DELETE https://app.wrenn.dev/api/v1/snapshots/my-template \
  -H "X-API-Key: wrn_your_api_key_here"

Response

Returns 204 No Content on success. No body is returned.

Python SDK

from wrenn import WrennClient

with WrennClient() as client:
    client.snapshots.delete("my-template")

Error responses

StatusMeaning
404 Not FoundNo template with that name exists for your team.