Sign in

v13

OpenAPI 3.0.32026-07-31359869.4 MB
sandboxes

Get or create a drive

Gets an existing drive by project and name, or creates it when it does not exist. Drives are in private beta. Register your interest to get access: https://vercel.com/changelog/drives-for-vercel-sandbox-in-private-beta

post/v2/sandboxes/drives/{name}

Path parameters

namestring required

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

Example:workspace

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

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

projectIdstring

The project ID or name to associate the drive with. Required unless using a Vercel OIDC token scoped to a project.

maxSizeBytesinteger

Maximum drive size in bytes. Defaults to 100 GiB when omitted.

Example request

{
  "projectId": "prj_abc123"
}

Response

Example response

{
  "drive": {
    "name": "workspace",
    "projectId": "prj_abc123",
    "maxSizeBytes": 107374182400,
    "currentSessionId": "sbx_123",
    "currentSandboxName": "my-sandbox",
    "createdAt": 1750344501629,
    "updatedAt": 1750344501629
  }
}