--- title: delete-a-sandbox product: vercel url: /docs/rest-api/sandboxes/delete-a-sandbox canonical_url: "https://vercel.com/docs/rest-api/sandboxes/delete-a-sandbox" last_updated: 2026-08-30 type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about delete-a-sandbox on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # Delete a sandbox ```http DELETE /v2/sandboxes/{name} ``` Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first. This operation deletes all sandbox entities with the given name and the named sandbox metadata. ## Authentication **bearerToken**: HTTP bearer ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | `name` | string. maxLength: 128; pattern: `^[a-zA-Z0-9_-]+$` | Yes | The sandbox name to delete. | ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `projectId` | string. maxLength: 128 | No | The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context. | | `deleteOrphanSnapshots` | boolean. default: false | No | When true, snapshots of the deleted sandbox that are not referenced by any other sandbox are also deleted asynchronously. Defaults to false. | | `teamId` | string | No | The Team identifier to perform the request on behalf of. | | `slug` | string | No | The Team slug to perform the request on behalf of. | ## Example request ### TypeScript ```typescript const response = await fetch('https://api.vercel.com/v2/sandboxes/name?projectId=string&deleteOrphanSnapshots=true&teamId=string&slug=string', { method: 'DELETE', headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json', }, }); const data = await response.json(); console.log(data); ``` ### Next.js ```typescript 'use server'; export async function callEndpoint() { const response = await fetch('https://api.vercel.com/v2/sandboxes/name?projectId=string&deleteOrphanSnapshots=true&teamId=string&slug=string', { method: 'DELETE', headers: { 'Authorization': `Bearer ${process.env.VERCEL_ACCESS_TOKEN}`, 'Content-Type': 'application/json', }, next: { revalidate: 3600 } }); if (!response.ok) { throw new Error('Request failed'); } return response.json(); } ``` ### cURL ```bash curl -X DELETE 'https://api.vercel.com/v2/sandboxes/name?projectId=string&deleteOrphanSnapshots=true&teamId=string&slug=string' \ -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ -H 'Content-Type: application/json' ``` ## Example response ```json { "sandbox": { "name": "my-sandbox", "currentSnapshotId": "example_id", "currentSessionId": "example_id", "status": "running", "statusUpdatedAt": "1750344501629", "persistent": "true", "region": "iad1", "failoverRegions": [], "vcpus": "2", "memory": "1024", "runtime": "node22", "image": "my-repo@sha256:2c4e8f9a1b3d5e7f091a2b3c4d5e6f708192a3b4c5d6e7f8091a2b3c4d5e6f708", "timeout": "300000", "snapshotExpiration": "604800000", "keepLastSnapshots": { "count": "5", "expiration": "604800000", "deleteEvicted": "true" }, "networkPolicy": { "mode": "allow-all", "allowedDomains": [], "allowedCIDRs": [], "deniedCIDRs": [], "s3Key": "string" }, "totalEgressBytes": "4096", "totalIngressBytes": "2048", "totalActiveCpuDurationMs": "5000", "totalDurationMs": "60000", "cwd": "/vercel/sandbox", "tags": "[object Object]", "mounts": "value", "createdAt": "1750344501629", "updatedAt": "1750344501629", "expiresAt": "1750344801629" } } ``` ## Responses ### 200: No description Content-Type: `application/json` ```json { "type": "object", "required": [ "sandbox" ], "properties": { "sandbox": { "type": "object", "description": "This object contains information related to a Vercel NamedSandbox.", "required": [ "createdAt", "currentSessionId", "name", "persistent", "status", "statusUpdatedAt", "updatedAt" ], "properties": { "name": { "type": "string", "description": "The unique identifier of the sandbox." }, "currentSnapshotId": { "type": "string", "description": "Current snapshot ID that the named sandbox is pointing to." }, "currentSessionId": { "type": "string", "description": "Current session ID the sandbox is pointing to." }, "status": { "type": "string", "description": "The status of the current sandbox.", "enum": [ "running", "stopped", "stopping" ] }, "statusUpdatedAt": { "type": "number", "description": "The time when the sandbox status was last updated, in milliseconds since the epoch." }, "persistent": { "type": "boolean", "description": "Whether the sandbox persists its state across restarts via automatic snapshots.", "enum": [ false, true ] }, "region": { "type": "string", "description": "The region the sandbox is pinned to: the region stored on the sandbox, otherwise the platform default. Where a running session actually landed is reported by `session.region`." }, "failoverRegions": { "type": "array", "description": "The regions the sandbox fails over to. Empty when it does not fail over.", "items": { "type": "string", "description": "The regions the sandbox fails over to. Empty when it does not fail over.", "enum": [ "arn1", "bom1", "cdg1", "cle1", "cpt1", "dub1", "fra1", "gru1", "hkg1", "hnd1", "iad1", "icn1", "kix1", "lhr1", "pdx1", "sfo1", "sin1", "syd1", "yul1" ] } }, "vcpus": { "type": "number", "description": "Number of virtual CPUs allocated." }, "memory": { "type": "number", "description": "Memory allocated in MB." }, "runtime": { "type": "string", "description": "Runtime identifier." }, "image": { "type": "string", "description": "Digest-pinned reference of the container image the sandbox was created from, when it was created from an image (\"{repository}@{manifestDigest}\")." }, "timeout": { "type": "number", "description": "Timeout in milliseconds." }, "snapshotExpiration": { "type": "number", "description": "Default snapshot expiration time in milliseconds. 0 means no expiration." }, "keepLastSnapshots": { "type": "object", "description": "Keep-last snapshot configuration.", "required": [ "count", "deleteEvicted" ], "properties": { "count": { "type": "number", "description": "Number of most recent snapshots to keep." }, "expiration": { "type": "number", "description": "Expiration time in milliseconds for kept snapshots." }, "deleteEvicted": { "type": "boolean", "description": "Whether to immediately delete evicted snapshots.", "enum": [ false, true ] } } }, "networkPolicy": { "type": "object", "description": "Network policy configuration.", "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "allow-all", "custom", "default-allow", "default-deny", "deny-all" ] }, "allowedDomains": { "type": "array" }, "allowedCIDRs": { "type": "array" }, "deniedCIDRs": { "type": "array" }, "s3Key": { "type": "string" } } }, "totalEgressBytes": { "type": "number", "description": "Cumulative egress bytes across all sandbox runs." }, "totalIngressBytes": { "type": "number", "description": "Cumulative ingress bytes across all sandbox runs." }, "totalActiveCpuDurationMs": { "type": "number", "description": "Cumulative active CPU duration in milliseconds across all sandbox runs." }, "totalDurationMs": { "type": "number", "description": "Cumulative wall-clock duration in milliseconds across all sandbox runs." }, "cwd": { "type": "string", "description": "The working directory of the sandbox." }, "tags": { "type": "object", "description": "Key-value tags attached to the named sandbox.", "additionalProperties": { "type": "string" } }, "mounts": { "type": "object", "description": "Key-value pairs of mount path and drive.", "additionalProperties": { "type": "object", "description": "Key-value pairs of mount path and drive.", "required": [ "drive" ] } }, "createdAt": { "type": "number", "description": "The time when the named sandbox was created, in milliseconds since the epoch." }, "updatedAt": { "type": "number", "description": "The time when the named sandbox was last updated, in milliseconds since the epoch." }, "expiresAt": { "type": "number", "description": "The time at which the currently running sandbox will time out, in milliseconds since the epoch. Only present while a session is running." } } } } } ``` ### 400: One of the provided values in the request query is invalid. ### 401: The request is not authorized. ### 403: You do not have permission to access this resource. ### 404: No description ### 410: No description ### 429: No description --- ## Related - [sandboxes endpoints](/docs/rest-api#sandboxes) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)