sandboxes

Fork a drive

Changed on

Fork the provided drive into a new one with the provided name, inheriting the region and max size.

post/v2/sandboxes/drives/{name}/fork

Request

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

Path parameters

namestring required

Name of the source drive to fork.

Example:workspace

Query parameters

projectIdstring

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

Example:prj_abc123
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

namestring required

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

Example request

{
  "name": "workspace-fork"
}

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