Interrupt running work

POST

boxes

{boxId}

interrupt

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/interrupt \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "type": "box.interrupted",
  "id": "bx_23456789",
  "status": "interrupted"
}

Authorization

string

header

required

Box API key in the form box_.... Create and rotate keys in the Box dashboard or through the v1 API key endpoints.

boxId

string

required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Interrupt requested.

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

Example:

"box.stopping"

string

required

status

string

required

Example:

"archiving"

box

object

Show child attributes

Interrupt running work

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/interrupt \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "type": "box.interrupted",
  "id": "bx_23456789",
  "status": "interrupted"
}