/vercel-sandboxes | Type: Application | PCID required: Yes
Tools
vercel_sandboxes_create_directory
Create a directory Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to create the directory in. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
cwd | string | No | — | The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. |
path | string | Yes | — | The path of the directory to create. Can be absolute or relative to the working directory. |
recursive | boolean | No | — | If true, creates parent directories as needed (like mkdir -p). If false, fails if parent directories do not exist. |
vercel_sandboxes_create_sandbox
Create a sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
env | object | No | — | Default environment variables for the sandbox. These are inherited by all commands unless overridden. |
networkPolicy | object | No | — | Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use “allow-all” mode to allow all traffic, “deny-all” to block all traffic or “custom” to provide specific rules. |
ports | any[] | No | — | List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. |
projectId | string | No | — | The target project slug or ID in which the sandbox will be assigned to. |
resources | object | No | — | Resources to define the VM |
runtime | string | No | — | The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. |
source | object | No | — | The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. |
timeout | integer | No | — | Maximum duration in milliseconds that the sandbox can run before being automatically stopped. |
vercel_sandboxes_create_sandboxes
Create a named sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
env | object | No | — | Default environment variables for the sandbox. These are inherited by all commands unless overridden. |
name | string | No | — | Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). |
networkPolicy | object | No | — | Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use “allow-all” mode to allow all traffic, “deny-all” to block all traffic or “custom” to provide specific rules. |
persistent | boolean | No | — | Whether the sandbox persists its state across restarts via automatic snapshots. Defaults to true. |
ports | any[] | No | — | List of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed. |
projectId | string | No | — | The target project slug or ID in which the sandbox will be assigned to. |
resources | object | No | — | Resources to define the VM |
runtime | string | No | — | The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. |
snapshotExpiration | object | No | — | Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. |
source | object | No | — | The source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot. |
tags | object | No | — | Key-value tags to associate with the sandbox. Maximum 5 tags. |
timeout | integer | No | — | Maximum duration in milliseconds that the sandbox can run before being automatically stopped. |
vercel_sandboxes_create_session_directory
Create a directory Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to create the directory in. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
cwd | string | No | — | The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. |
path | string | Yes | — | The path of the directory to create. Can be absolute or relative to the working directory. |
recursive | boolean | No | — | If true, creates parent directories as needed (like mkdir -p). If false, fails if parent directories do not exist. |
vercel_sandboxes_create_session_snapshot
Create a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to snapshot. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
expiration | object | No | — | The number of milliseconds after which the snapshot will expire and be deleted. Use 0 for no expiration. |
vercel_sandboxes_create_snapshot
Create a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to snapshot. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
expiration | object | No | — | The number of milliseconds after which the snapshot will expire and be deleted. Use 0 for no expiration. |
vercel_sandboxes_delete_sandbox
Delete a sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The sandbox name to delete. |
projectId | string | No | — | The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_delete_session_snapshot
Delete a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
snapshotId | string | Yes | — | The unique identifier of the snapshot to delete. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_delete_snapshot
Delete a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
snapshotId | string | Yes | — | The unique identifier of the snapshot to delete. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_extend_sandbox_timeout
Extend sandbox timeout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to extend the timeout for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
duration | number | Yes | — | The amount of time in milliseconds to add to the current timeout. Must be at least 1000ms (1 second). |
vercel_sandboxes_extend_session_timeout
Extend session timeout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to extend the timeout for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
duration | number | Yes | — | The amount of time in milliseconds to add to the current timeout. Must be at least 1000ms (1 second). |
vercel_sandboxes_get_command
Get a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox containing the command. |
cmdId | string | Yes | — | The unique identifier of the command to retrieve. |
wait | string | No | — | If set to “true”, the request will block until the command finishes execution. Useful for synchronously waiting for command completion. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_command_logs
Stream command logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox containing the command. |
cmdId | string | Yes | — | The unique identifier of the command to stream logs for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_named_sandbox
Get a named sandbox Parameters:| Parameter | Type | Required | Default | 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. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_sandbox
Get a sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to retrieve. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_session
Get a session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to retrieve. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_session_command
Get a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session containing the command. |
cmdId | string | Yes | — | The unique identifier of the command to retrieve. |
wait | string | No | — | If set to “true”, the request will block until the command finishes execution. Useful for synchronously waiting for command completion. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_session_command_logs
Stream command logs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session containing the command. |
cmdId | string | Yes | — | The unique identifier of the command to stream logs for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_session_snapshot
Get a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
snapshotId | string | Yes | — | The unique identifier of the snapshot to retrieve. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_snapshot
Get a snapshot Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
snapshotId | string | Yes | — | The unique identifier of the snapshot to retrieve. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_v1
List sandboxes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | The unique identifier or name of the project to list sandboxes for. |
limit | number | No | — | Maximum number of sandboxes to return in the response. Used for pagination. |
since | number | No | — | Filter sandboxes created after this timestamp. Specified as Unix time in milliseconds. |
until | number | No | — | Filter sandboxes created before this timestamp. Specified as Unix time in milliseconds. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_get_v2
List sandboxes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | The unique identifier or name of the project to list named sandboxes for. |
limit | number | No | — | Maximum number of named sandboxes to return in the response. Used for pagination. |
sortBy | string | No | — | Field to sort by. |
namePrefix | string | No | — | Filter named sandboxes whose name starts with this prefix. Only valid when sortBy=name. |
cursor | string | No | — | Opaque pagination cursor from a previous response. |
sortOrder | string | No | — | Sort direction. Defaults to desc. |
tags | any[] | No | — | Filter sandboxes by tag. Format: “key:value”. Only one tag filter is supported at a time. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_kill_command
Kill a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cmdId | string | Yes | — | The unique identifier of the command to terminate. |
sandboxId | string | Yes | — | The unique identifier of the sandbox containing the command. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
signal | number | Yes | — | The POSIX signal number to send to the process. Common values: 15 (SIGTERM) for graceful termination, 9 (SIGKILL) for forced termination. |
vercel_sandboxes_kill_session_command
Kill a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cmdId | string | Yes | — | The unique identifier of the command to terminate. |
sessionId | string | Yes | — | The unique identifier of the session containing the command. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
signal | number | Yes | — | The POSIX signal number to send to the process. Common values: 15 (SIGTERM) for graceful termination, 9 (SIGKILL) for forced termination. |
vercel_sandboxes_list_commands
List commands Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to list commands for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_list_session_commands
List commands Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to list commands for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_list_session_snapshots
List snapshots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | The unique identifier or name of the project to list snapshots for. |
name | string | No | — | Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). |
limit | number | No | — | Maximum number of snapshots to return in the response. Used for pagination. |
cursor | string | No | — | Opaque pagination cursor from a previous response. |
sortOrder | string | No | — | Sort direction for results by creation time. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_list_sessions
List sessions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | The unique identifier or name of the project to list sessions for. |
name | string | No | — | Filter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned. |
limit | number | No | — | Maximum number of sessions to return in the response. Used for pagination. |
cursor | string | No | — | Opaque pagination cursor from a previous response. |
sortOrder | string | No | — | Sort direction for results by creation time. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_list_snapshots
List snapshots Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
project | string | No | — | The unique identifier or name of the project to list snapshots for. |
limit | number | No | — | Maximum number of snapshots to return in the response. Used for pagination. |
since | number | No | — | Filter snapshots created after this timestamp. Specified as Unix time in milliseconds. |
until | number | No | — | Filter snapshots created before this timestamp. Specified as Unix time in milliseconds. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_read_file
Read a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to read the file from. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
cwd | string | No | — | The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. |
path | string | Yes | — | The path of the file to read. Can be absolute or relative to the working directory. |
vercel_sandboxes_read_session_file
Read a file Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to read the file from. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
cwd | string | No | — | The base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory. |
path | string | Yes | — | The path of the file to read. Can be absolute or relative to the working directory. |
vercel_sandboxes_run_command
Execute a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox in which to execute the command. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
args | any[] | No | — | Arguments to pass to the command. Each argument should be a separate array element. |
command | string | Yes | — | The executable or shell command to run. This is the program name without arguments. |
cwd | string | No | — | The working directory in which to execute the command. Defaults to the sandbox home directory if not specified. |
env | object | No | — | Additional environment variables to set for this command. These are merged with the sandbox environment. |
sudo | boolean | No | — | Execute the command with root (superuser) privileges. |
wait | boolean | No | — | If true, returns an ND-JSON stream that emits the command status when started and again when finished. Useful for synchronously waiting for command completion. |
vercel_sandboxes_run_session_command
Execute a command Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session in which to execute the command. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
args | any[] | No | — | Arguments to pass to the command. Each argument should be a separate array element. |
command | string | Yes | — | The executable or shell command to run. This is the program name without arguments. |
cwd | string | No | — | The working directory in which to execute the command. Defaults to the sandbox home directory if not specified. |
env | object | No | — | Additional environment variables to set for this command. These are merged with the sandbox environment. |
sudo | boolean | No | — | Execute the command with root (superuser) privileges. |
wait | boolean | No | — | If true, returns an ND-JSON stream that emits the command status when started and again when finished. Useful for synchronously waiting for command completion. |
vercel_sandboxes_stop_sandbox
Stop a sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to stop. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_stop_session
Stop a session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to stop. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_update_network_policy
Update network policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to update the network policy for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
allowedCIDRs | any[] | No | — | List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. |
allowedDomains | any[] | No | — | List of domain names the sandbox is allowed to connect to. Only applies when mode is “custom”. Supports wildcard patterns (e.g., “*.example.com” matches all subdomains). |
deniedCIDRs | any[] | No | — | List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. |
mode | string | Yes | — | The network access policy mode. Use “allow-all” to permit all outbound traffic. Use “deny-all” to block all outbound traffic. Use “custom” to specify explicit allow/deny rules. |
vercel_sandboxes_update_sandbox
Update a sandbox Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The sandbox to update. |
projectId | string | No | — | The project ID that owns the named sandbox. When provided, takes precedence over OIDC project context. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
env | object | No | — | Default environment variables for the sandbox. Set to empty object to clear. |
networkPolicy | object | No | — | Network access policy for the sandbox.\n Controls which external hosts the sandbox can communicate with.\n Use “allow-all” mode to allow all traffic, “deny-all” to block all traffic or “custom” to provide specific rules. |
persistent | boolean | No | — | Whether the sandbox persists its state across restarts via automatic snapshots. |
resources | object | No | — | Resources to define the VM |
runtime | string | No | — | The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. |
snapshotExpiration | object | No | — | Default snapshot expiration time in milliseconds. Set to 0 to disable expiration. When set, this value is used as the default expiration for all snapshots created for this sandbox. |
tags | object | No | — | Key-value tags to associate with the sandbox. Replaces existing tags. Set to empty object to clear. Maximum 5 tags. |
timeout | integer | No | — | Maximum duration in milliseconds that the sandbox can run before being automatically stopped. |
vercel_sandboxes_update_session_network_policy
Update network policy Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to update the network policy for. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
allowedCIDRs | any[] | No | — | List of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions. |
allowedDomains | any[] | No | — | List of domain names the sandbox is allowed to connect to. Only applies when mode is “custom”. Supports wildcard patterns (e.g., “*.example.com” matches all subdomains). |
deniedCIDRs | any[] | No | — | List of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules. |
mode | string | Yes | — | The network access policy mode. Use “allow-all” to permit all outbound traffic. Use “deny-all” to block all outbound traffic. Use “custom” to specify explicit allow/deny rules. |
vercel_sandboxes_write_files
Write files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sandboxId | string | Yes | — | The unique identifier of the sandbox to write files to. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |
vercel_sandboxes_write_session_files
Write files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sessionId | string | Yes | — | The unique identifier of the session to write files to. |
teamId | string | No | — | The Team identifier to perform the request on behalf of. |
slug | string | No | — | The Team slug to perform the request on behalf of. |

