Skip to navigation
Modbox APIsandboxes

Destroy a sandbox

View as Markdown

Deletes every resource backing the sandbox (deployment, service, route, network policy and pull secret).

This operation is idempotent: destroying an already-destroyed sandbox succeeds. Sandboxes created with ttl_seconds are destroyed automatically when it elapses.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-workspace-idstring or nullOptional

UUID of the workspace that scopes this request. List the workspaces you belong to with GET /workspaces.

Request

This endpoint expects an object.
task_idstringRequired1-255 characters
The name used when the sandbox was provisioned.

Response

Successful Response
successboolean
True when every resource was removed.
errorstring or nullOptional

Failure reason when success is false.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error