Skip to content
Docs

List drives

GEThttps://api.vercel.com/v2/sandboxes/drives
Retrieves a paginated list of drives belonging to a specific project.
https://api.vercel.com/v2/sandboxes/drives
const response = await fetch('https://api.vercel.com/v2/sandboxes/drives?projectId=string&limit=123&cursor=string&sortBy=string&namePrefix=string&sortOrder=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "drives": [
    {
      "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"
    }
  ],
  "pagination": {
    "count": "123",
    "next": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectIdstringOptional
The project ID or name associated with the drives. Required unless using a Vercel OIDC token scoped to a project.
limitnumberOptional
Maximum number of drives to return in the response. Used for pagination.
cursorstringOptional
Opaque pagination cursor from a previous response.
sortBystringOptional
Field to sort drives by.
namePrefixstringOptional
Filter drives whose name starts with this prefix. Only valid when sortBy=name.
sortOrderstringOptional
Sort direction for results.
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
drivesarrayRequired

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
410Error
429Error