Create Snapshot

POST
/workspaces
/:workspace
/sandboxes
/:sandbox_id
/snapshots

Creates a snapshot of an existing sandbox.

Request

REQUIRED SCOPES

WORKSPACE, SANDBOX_MANAGE

URL PARAMETERS

workspacerequired string

The workspace name.

sandbox_idrequired string

The ID of the sandbox.

POST PARAMETERS

namerequired string

The name of the snapshot.

Last modified on Sep 4, 2025

Edit Sandbox YAML Get Sandbox Snapshots

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/sandboxes/:sandbox_id/snapshots" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "my-new-sandbox-010925"
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/sandboxes/jp517h9nuas7j/snapshots/sn-z693rqah9ovrh",
  "html_url": "https://app.buddy.works/buddy/my-project/sandboxes/jp517h9nuas7j/snapshots",
  "id": "sn-z693rqah9ovrh",
  "name": "my-new-sandbox-010925",
  "status": "CREATING",
  "create_date": "2025-09-01T12:43:06.451436826Z",
  "created_by": {
    "url": "https://api.buddy.works/workspaces/buddy/members/1",
    "html_url": "https://app.buddy.works/buddy/profile/1",
    "id": 1,
    "name": "John Deer",
    "avatar_url": "https://app.buddy.works/image-server/user/0/0/0/0/0/0/1/d643744fbe5ebf2906a4d075a5b97110/w/32/32/AVATAR.png",
    "email": "john-deer@email.com",
    "admin": true,
    "workspace_owner": true
  }
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999