---
title: get_named_sandbox
product: vercel
url: /docs/agent-resources/vercel-mcp/tools/sandboxes/get_named_sandbox
canonical_url: "https://vercel.com/docs/agent-resources/vercel-mcp/tools/sandboxes/get_named_sandbox"
last_updated: 2018-10-20
type: reference
prerequisites:
  - /docs/agent-resources/vercel-mcp/tools/sandboxes
  - /docs/agent-resources/vercel-mcp/tools
related:
  []
summary: Use get_named_sandbox with Vercel MCP.
install_vercel_plugin: npx plugins add vercel/vercel-plugin
---

# get_named_sandbox

Get a named sandbox.

## Parameters

| Parameter   | Type    | Required | Description                                                                                                                                |
| ----------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `name`      | string  | Yes      | Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).                                        |
| `projectId` | string  | No       | The project ID or name (required when not using OIDC token).                                                                               |
| `resume`    | boolean | No       | Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false. Default: `false`. |
| `teamId`    | string  | No       | Team ID.                                                                                                                                   |
| `slug`      | string  | No       | Team slug.                                                                                                                                 |


---

[View full sitemap](/docs/sitemap)
