Skip to content
Docs

Get a drive

GET/__remote/api.vercel.com/v2/sandboxes/drives/{nameOrId}
Gets an existing drive by project and name or drive ID. Returns 404 if doesn't exist.
Request
import { Edgenivo } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.sandboxes.getDrive({
    nameOrId: "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",
    "workloadType": "sandbox"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

nameOrIdstringRequired
The drive name or ID.

Query parameters

projectIdstringOptional
The project ID or name associated with the drive. Required unless using a Edgenivo 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 Edgenivo 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
410Error
422Error
429Error