Docs
Snapshots and forks ›

Delete snapshot

DELETE/v1/snapshots/{id}

Delete a snapshot.

RequestTypeScript
  1. import { Agental } from "agental-sdk";
  2. const agental = new Agental();
  3. await agental.snapshots.delete("snap_7f3c1a9e0b24d658");
Answer204 No Content

No body: the status says it was done.

Snapshot deleted.

Path

idrequired
string

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

204 Snapshot deleted. Sandboxes made from it are not affected.

Errors and other answers

404 Not found.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.