Delete a machine

DELETE

sandboxes

{sandboxID}

curl --request DELETE \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header 'Idempotency-Key: 48fcb7cf-0f9e-4612-bd37-4c66171c2aae'

# sandbox is returned by Sandbox.create or Sandbox.connect.
sandbox.kill()

// sandbox is returned by Sandbox.create or Sandbox.connect.
await sandbox.kill();

{
  "operationID": "<string>",
  "status": "<string>",
  "statusURL": "<string>"
}

Authentication

Send your scoped bearer token in the Authorization: Bearer <BEAD_TOKEN> header, or send your API key in X-API-Key.

Parameters

string

required

Machine identifier returned by creation.

string

Caller-generated durable retry key: lowercase ASCII letters, digits, and hyphens only. Reuse the same key and body after a connection failure. Minimum length: 1. Maximum length: 255.

curl --request DELETE \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header 'Idempotency-Key: 48fcb7cf-0f9e-4612-bd37-4c66171c2aae'

# sandbox is returned by Sandbox.create or Sandbox.connect.
sandbox.kill()

// sandbox is returned by Sandbox.create or Sandbox.connect.
await sandbox.kill();

Response

202

Deletion accepted; poll statusURL until status is deleted.

string

required

Operation UUID to poll for completion. Format: uuid.

string

required

Current operation state. Allowed values: "deleting".

string

required

Relative URL to poll operation progress.

204

The sandbox was killed successfully. No response body.

Errors

Status	Meaning
401	Authentication credential is missing or rejected.
403	The credential lacks the required scope.
404	The requested resource does not exist or is outside your organization.
429	Request or resource admission limit exceeded (`admission_limit`; trial capacity can return `free_capacity_full`). Follow limit.next_action and Retry-After when present.
503	Service or persistence is temporarily unavailable.

curl --request DELETE \
  --url "https://api.bead.run/sandboxes/$SANDBOX_ID" \
  --header "X-API-Key: $BEAD_API_KEY" \
  --header 'Idempotency-Key: 48fcb7cf-0f9e-4612-bd37-4c66171c2aae'

# sandbox is returned by Sandbox.create or Sandbox.connect.
sandbox.kill()

// sandbox is returned by Sandbox.create or Sandbox.connect.
await sandbox.kill();

{
  "operationID": "<string>",
  "status": "<string>",
  "statusURL": "<string>"
}

Start here

Endpoints

Delete a machine

Authentication

Parameters

Response

202

204

Errors

​Authentication

​Parameters

​Response

​202

​204

​Errors

Authentication

Parameters

Response

202

204

Errors