Skip to main content
Server path: /vercel-sandboxes | Type: Application | PCID required: Yes

Tools

ToolDescription
vercel_sandboxes_create_directoryCreate a directory
vercel_sandboxes_create_sandboxCreate a sandbox
vercel_sandboxes_create_sandboxesCreate a named sandbox
vercel_sandboxes_create_session_directoryCreate a directory
vercel_sandboxes_create_session_snapshotCreate a snapshot
vercel_sandboxes_create_snapshotCreate a snapshot
vercel_sandboxes_delete_sandboxDelete a sandbox
vercel_sandboxes_delete_session_snapshotDelete a snapshot
vercel_sandboxes_delete_snapshotDelete a snapshot
vercel_sandboxes_extend_sandbox_timeoutExtend sandbox timeout
vercel_sandboxes_extend_session_timeoutExtend session timeout
vercel_sandboxes_get_commandGet a command
vercel_sandboxes_get_command_logsStream command logs
vercel_sandboxes_get_named_sandboxGet a named sandbox
vercel_sandboxes_get_sandboxGet a sandbox
vercel_sandboxes_get_sessionGet a session
vercel_sandboxes_get_session_commandGet a command
vercel_sandboxes_get_session_command_logsStream command logs
vercel_sandboxes_get_session_snapshotGet a snapshot
vercel_sandboxes_get_snapshotGet a snapshot
vercel_sandboxes_get_v1List sandboxes
vercel_sandboxes_get_v2List sandboxes
vercel_sandboxes_kill_commandKill a command
vercel_sandboxes_kill_session_commandKill a command
vercel_sandboxes_list_commandsList commands
vercel_sandboxes_list_session_commandsList commands
vercel_sandboxes_list_session_snapshotsList snapshots
vercel_sandboxes_list_sessionsList sessions
vercel_sandboxes_list_snapshotsList snapshots
vercel_sandboxes_read_fileRead a file
vercel_sandboxes_read_session_fileRead a file
vercel_sandboxes_run_commandExecute a command
vercel_sandboxes_run_session_commandExecute a command
vercel_sandboxes_stop_sandboxStop a sandbox
vercel_sandboxes_stop_sessionStop a session
vercel_sandboxes_update_network_policyUpdate network policy
vercel_sandboxes_update_sandboxUpdate a sandbox
vercel_sandboxes_update_session_network_policyUpdate network policy
vercel_sandboxes_write_filesWrite files
vercel_sandboxes_write_session_filesWrite files

vercel_sandboxes_create_directory

Create a directory Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to create the directory in.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
cwdstringNoThe base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.
pathstringYesThe path of the directory to create. Can be absolute or relative to the working directory.
recursivebooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
envobjectNoDefault environment variables for the sandbox. These are inherited by all commands unless overridden.
networkPolicyobjectNoNetwork 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.
portsany[]NoList of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed.
projectIdstringNoThe target project slug or ID in which the sandbox will be assigned to.
resourcesobjectNoResources to define the VM
runtimestringNoThe runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available.
sourceobjectNoThe source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot.
timeoutintegerNoMaximum duration in milliseconds that the sandbox can run before being automatically stopped.

vercel_sandboxes_create_sandboxes

Create a named sandbox Parameters:
ParameterTypeRequiredDefaultDescription
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
envobjectNoDefault environment variables for the sandbox. These are inherited by all commands unless overridden.
namestringNoName for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
networkPolicyobjectNoNetwork 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.
persistentbooleanNoWhether the sandbox persists its state across restarts via automatic snapshots. Defaults to true.
portsany[]NoList of ports to expose from the sandbox. Each port will be accessible via a unique URL. Maximum of 15 ports can be exposed.
projectIdstringNoThe target project slug or ID in which the sandbox will be assigned to.
resourcesobjectNoResources to define the VM
runtimestringNoThe runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available.
snapshotExpirationobjectNoDefault 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.
sourceobjectNoThe source from which to initialize the sandbox filesystem. Can be a Git repository, a tarball URL, or an existing snapshot.
tagsobjectNoKey-value tags to associate with the sandbox. Maximum 5 tags.
timeoutintegerNoMaximum duration in milliseconds that the sandbox can run before being automatically stopped.

vercel_sandboxes_create_session_directory

Create a directory Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to create the directory in.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
cwdstringNoThe base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.
pathstringYesThe path of the directory to create. Can be absolute or relative to the working directory.
recursivebooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to snapshot.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
expirationobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to snapshot.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
expirationobjectNoThe 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:
ParameterTypeRequiredDefaultDescription
namestringYesThe sandbox name to delete.
projectIdstringNoThe project ID that owns the named sandbox. When provided, takes precedence over OIDC project context.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_delete_session_snapshot

Delete a snapshot Parameters:
ParameterTypeRequiredDefaultDescription
snapshotIdstringYesThe unique identifier of the snapshot to delete.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_delete_snapshot

Delete a snapshot Parameters:
ParameterTypeRequiredDefaultDescription
snapshotIdstringYesThe unique identifier of the snapshot to delete.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_extend_sandbox_timeout

Extend sandbox timeout Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to extend the timeout for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
durationnumberYesThe 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:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to extend the timeout for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
durationnumberYesThe 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:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox containing the command.
cmdIdstringYesThe unique identifier of the command to retrieve.
waitstringNoIf set to “true”, the request will block until the command finishes execution. Useful for synchronously waiting for command completion.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_command_logs

Stream command logs Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox containing the command.
cmdIdstringYesThe unique identifier of the command to stream logs for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_named_sandbox

Get a named sandbox Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
projectIdstringNoThe project ID or name (required when not using OIDC token).
resumebooleanNoWhether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_sandbox

Get a sandbox Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to retrieve.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_session

Get a session Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to retrieve.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_session_command

Get a command Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session containing the command.
cmdIdstringYesThe unique identifier of the command to retrieve.
waitstringNoIf set to “true”, the request will block until the command finishes execution. Useful for synchronously waiting for command completion.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_session_command_logs

Stream command logs Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session containing the command.
cmdIdstringYesThe unique identifier of the command to stream logs for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_session_snapshot

Get a snapshot Parameters:
ParameterTypeRequiredDefaultDescription
snapshotIdstringYesThe unique identifier of the snapshot to retrieve.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_snapshot

Get a snapshot Parameters:
ParameterTypeRequiredDefaultDescription
snapshotIdstringYesThe unique identifier of the snapshot to retrieve.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_v1

List sandboxes Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoThe unique identifier or name of the project to list sandboxes for.
limitnumberNoMaximum number of sandboxes to return in the response. Used for pagination.
sincenumberNoFilter sandboxes created after this timestamp. Specified as Unix time in milliseconds.
untilnumberNoFilter sandboxes created before this timestamp. Specified as Unix time in milliseconds.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_get_v2

List sandboxes Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoThe unique identifier or name of the project to list named sandboxes for.
limitnumberNoMaximum number of named sandboxes to return in the response. Used for pagination.
sortBystringNoField to sort by.
namePrefixstringNoFilter named sandboxes whose name starts with this prefix. Only valid when sortBy=name.
cursorstringNoOpaque pagination cursor from a previous response.
sortOrderstringNoSort direction. Defaults to desc.
tagsany[]NoFilter sandboxes by tag. Format: “key:value”. Only one tag filter is supported at a time.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_kill_command

Kill a command Parameters:
ParameterTypeRequiredDefaultDescription
cmdIdstringYesThe unique identifier of the command to terminate.
sandboxIdstringYesThe unique identifier of the sandbox containing the command.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
signalnumberYesThe 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:
ParameterTypeRequiredDefaultDescription
cmdIdstringYesThe unique identifier of the command to terminate.
sessionIdstringYesThe unique identifier of the session containing the command.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
signalnumberYesThe 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:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to list commands for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_list_session_commands

List commands Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to list commands for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_list_session_snapshots

List snapshots Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoThe unique identifier or name of the project to list snapshots for.
namestringNoName for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores).
limitnumberNoMaximum number of snapshots to return in the response. Used for pagination.
cursorstringNoOpaque pagination cursor from a previous response.
sortOrderstringNoSort direction for results by creation time.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_list_sessions

List sessions Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoThe unique identifier or name of the project to list sessions for.
namestringNoFilter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned.
limitnumberNoMaximum number of sessions to return in the response. Used for pagination.
cursorstringNoOpaque pagination cursor from a previous response.
sortOrderstringNoSort direction for results by creation time.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_list_snapshots

List snapshots Parameters:
ParameterTypeRequiredDefaultDescription
projectstringNoThe unique identifier or name of the project to list snapshots for.
limitnumberNoMaximum number of snapshots to return in the response. Used for pagination.
sincenumberNoFilter snapshots created after this timestamp. Specified as Unix time in milliseconds.
untilnumberNoFilter snapshots created before this timestamp. Specified as Unix time in milliseconds.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_read_file

Read a file Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to read the file from.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
cwdstringNoThe base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.
pathstringYesThe path of the file to read. Can be absolute or relative to the working directory.

vercel_sandboxes_read_session_file

Read a file Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to read the file from.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
cwdstringNoThe base directory for resolving relative paths. If not specified, paths are resolved from the sandbox home directory.
pathstringYesThe path of the file to read. Can be absolute or relative to the working directory.

vercel_sandboxes_run_command

Execute a command Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox in which to execute the command.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
argsany[]NoArguments to pass to the command. Each argument should be a separate array element.
commandstringYesThe executable or shell command to run. This is the program name without arguments.
cwdstringNoThe working directory in which to execute the command. Defaults to the sandbox home directory if not specified.
envobjectNoAdditional environment variables to set for this command. These are merged with the sandbox environment.
sudobooleanNoExecute the command with root (superuser) privileges.
waitbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session in which to execute the command.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
argsany[]NoArguments to pass to the command. Each argument should be a separate array element.
commandstringYesThe executable or shell command to run. This is the program name without arguments.
cwdstringNoThe working directory in which to execute the command. Defaults to the sandbox home directory if not specified.
envobjectNoAdditional environment variables to set for this command. These are merged with the sandbox environment.
sudobooleanNoExecute the command with root (superuser) privileges.
waitbooleanNoIf 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:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to stop.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_stop_session

Stop a session Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to stop.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_update_network_policy

Update network policy Parameters:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to update the network policy for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
allowedCIDRsany[]NoList of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions.
allowedDomainsany[]NoList 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).
deniedCIDRsany[]NoList of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules.
modestringYesThe 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:
ParameterTypeRequiredDefaultDescription
namestringYesThe sandbox to update.
projectIdstringNoThe project ID that owns the named sandbox. When provided, takes precedence over OIDC project context.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
envobjectNoDefault environment variables for the sandbox. Set to empty object to clear.
networkPolicyobjectNoNetwork 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.
persistentbooleanNoWhether the sandbox persists its state across restarts via automatic snapshots.
resourcesobjectNoResources to define the VM
runtimestringNoThe runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available.
snapshotExpirationobjectNoDefault 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.
tagsobjectNoKey-value tags to associate with the sandbox. Replaces existing tags. Set to empty object to clear. Maximum 5 tags.
timeoutintegerNoMaximum duration in milliseconds that the sandbox can run before being automatically stopped.

vercel_sandboxes_update_session_network_policy

Update network policy Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to update the network policy for.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.
allowedCIDRsany[]NoList of IP address ranges (in CIDR notation) the sandbox is allowed to connect to. Traffic to these addresses bypasses domain-based restrictions.
allowedDomainsany[]NoList 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).
deniedCIDRsany[]NoList of IP address ranges (in CIDR notation) the sandbox is blocked from connecting to. These rules take precedence over all allowed rules.
modestringYesThe 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:
ParameterTypeRequiredDefaultDescription
sandboxIdstringYesThe unique identifier of the sandbox to write files to.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.

vercel_sandboxes_write_session_files

Write files Parameters:
ParameterTypeRequiredDefaultDescription
sessionIdstringYesThe unique identifier of the session to write files to.
teamIdstringNoThe Team identifier to perform the request on behalf of.
slugstringNoThe Team slug to perform the request on behalf of.