PATCH /v2/sandboxes/{name}
Updates the configuration of a sandbox. Only the provided fields will be modified; omitted fields remain unchanged.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
The sandbox to update. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
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. |
resume |
Boolean | No |
Whether to automatically resume a stopped named sandbox by creating a new instance from its snapshot. Defaults to false. Default value: false |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
networkPolicy |
No | ||
env |
Object | No |
Default environment variables for the sandbox. Set to empty object to clear. |
resources |
Object | No |
Resources to define the VM |
resources.memory |
Integer | No |
The amount of memory in megabytes to allocate to the sandbox. Must equal vcpus * 2048. |
resources.vcpus |
Integer | No |
The number of virtual CPUs to allocate to the sandbox. Must be 1, or an even number. |
persistent |
Boolean | No |
Whether the sandbox persists its state across restarts via automatic snapshots. |
currentSnapshotId |
String | No |
The snapshot ID to set as the current snapshot. Must be active and belong to the same project. |
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. |
keepLastSnapshots |
No |
Protect the N most recent snapshots with different expiration/deletion behavior. Set to null to clear. |
|
ports[] |
Array | 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. |
runtime |
String | No |
The runtime environment for the sandbox. Determines the pre-installed language runtimes and tools available. Valid values:
|
snapshotExpiration |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.