sandboxes

Get or create a drive

Changed on

Gets an existing drive by project and name, or creates it when it does not exist.

post/v2/sandboxes/drives/{name}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/sandboxes/drives/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

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

Example:workspace

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. Must be a multiple of 4096 bytes. Defaults to 1 TiB when omitted (1 GiB for Hobby). The maximum quota is 16 TiB. Request a quota above 16 TiB at https://vercel.com/help.

region'iad1' | 'sfo1' | 'cle1' | 'cdg1' | 'fra1' | 'arn1' | 'sin1' | 'pdx1' | 'lhr1' | 'icn1' | 'bom1' | 'cpt1' | 'dub1' | 'gru1' | 'hkg1' | 'syd1' | 'yul1' | 'hnd1' | 'kix1'

Region where the drive is stored. Defaults to iad1.

Example request

{
  "projectId": "prj_abc123",
  "region": "iad1"
}

Response

Example response

{
  "drive": {
    "createdAt": 1750344501629,
    "currentSandboxName": "my-sandbox",
    "currentSessionId": "sbx_123",
    "id": "drive_abc123",
    "maxSizeBytes": 1099511627776,
    "name": "workspace",
    "projectId": "prj_abc123",
    "region": "iad1",
    "updatedAt": 1750344501629
  }
}

Changes

  • 4a06e85c2848Revision changes
    • info

      added the non-success response with the status

  • b426de1e3932Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status