v1

latestOpenAPI 3.1.02026-07-22304756.7 KB

Box

Fork box

post/boxes/{boxId}/fork

boxIdstring required

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

envobject

Replaces the env the fork would otherwise inherit from the source box. Same validation rules as CreateBoxRequest.env.

noEnvboolean

Make the fork no-env (see CreateBoxRequest.noEnv). A fork of a no-env box is always no-env regardless of this field.

Fork started. The response id is the new forked box id.

okboolean required

typestring required

Stable success envelope discriminator added by v1.

idstring required

statusstring required

{
  "ok": true,
  "type": "box.stopping",
  "status": "archiving",
  "box": {
    "id": "bx_23456789",
    "name": "Box 2026-05-31 12:00"
  }
}