Skip to content
Docs

Delete a drive

DELhttps://api.vercel.com/v2/sandboxes/drives/{name}
Deletes a drive by project and name. Attached drives cannot be deleted. Stop or replace the session currently using the drive before retrying deletion.
Request
import { Vercel } from "@vercel/sdk";


const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});


async function run() {
  const result = await vercel.sandboxes.deleteDrive({
    name: "workspace",
    projectId: "prj_abc123",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
{
  "drive": {
    "createdAt": "1750344501629",
    "currentSandboxName": "my-sandbox",
    "currentSessionId": "sbx_123",
    "id": "drive_abc123",
    "maxSizeBytes": "1099511627776",
    "name": "workspace",
    "parentDriveId": "example_id",
    "projectId": "prj_abc123",
    "region": "iad1",
    "rootDriveId": "example_id",
    "updatedAt": "1750344501629",
    "v0": "false"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

namestringRequired
Name for the drive. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).

Query parameters

projectIdstringOptional
The project ID or name associated with the drive. Required unless using a Vercel OIDC token scoped to a project.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
driveobjectRequired
This object contains information related to a Vercel Sandbox Drive.

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error
429Error