DELETE /v2/sandboxes/{name}

Deletes a sandbox by name. If sandboxes are currently running, they will be stopped first. This operation deletes all sandbox entities with the given name and the named sandbox metadata.

Servers

Path parameters

Name Type Required Description
name String Yes

The sandbox name to delete.

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.