GET /v2/sandboxes/{name}
Retrieves a named sandbox by name, including its current sandbox and routes. If the sandbox is stopped and resume is true, a new sandbox will be created from the most recent snapshot.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
name |
String | Yes |
Name for the sandbox. Must be unique per project and URL-safe (alphanumeric, hyphens, underscores). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
String | No |
The project ID or name (required when not using OIDC token). |
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 |
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.