Skip to main content
PUT
/
sandboxes
/
{sandboxName}
/
stop
Stop Sandbox
curl --request PUT \
  --url https://api.blaxel.ai/v0/sandboxes/{sandboxName}/stop \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "metadata": {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "displayName": "<string>",
    "labels": {},
    "name": "<string>",
    "plan": "<any>",
    "url": "<string>",
    "workspace": "<string>"
  },
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
sandboxName
string
required

Name of the Sandbox

Response

successful operation

Response when stopping a Sandbox

​
message
string

Human readable message about the stop operation

​
metadata
object

Metadata Time fields for Persistance Owner fields for Persistance

​
status
string

Status of the Sandbox stop operation