Snapshots and forks ›
List sandbox snapshots
GET
/v1/sandboxes/{id}/snapshotsThe snapshots of one sandbox.
RequestTypeScript
- import { Agental } from "agental-sdk";
- const agental = new Agental();
- const sandbox = await agental.sandboxes.get("sbx_2a9a47e50daec64a");
- const snapshots = await sandbox.snapshots();
Answer200 OK
- {
- "snapshots": [{
- "id": string,
- "sandboxId": string,
- "name": string,
- "createdAt": string,
- "browsable": boolean,
- "size": string | null,
- … 1 more
- }],
- }
Snapshots for this sandbox.
Path
idrequiredstring | e.g. "sbx_0123456789abcdef" |
Headers
AuthorizationrequiredBearer key | An API key that may make this call. |
Returns
200 Snapshots for this sandbox.
JSON1 field
snapshotsSnapshot[]7 fields
idstring
sandboxIdstring
namestring
createdAtstring
browsableboolean
Whether the files in it can be listed and downloaded.
More
False for a snapshot of the whole machine: roll back to it to reach them.sizestringnull
The size of the sandbox it was taken of.
More
A sandbox made from it gets this size unless another, with no less disk, is asked for.sandboxDeletedboolean
Whether the sandbox it was taken of has been deleted.
More
The snapshot is kept either way, and a new sandbox can still be made from it.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.