Skip to main content
POST
Fork box

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

boxId
string
required

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

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

Body

application/json
env
object

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

noEnv
boolean

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

Response

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

ok
boolean
required
Example:

true

type
string
required

Stable success envelope discriminator added by v1.

Example:

"box.stopping"

id
string
required
status
string
required
Example:

"archiving"

box
object | null