Skip to main content
POST
/
boxes
/
{boxId}
/
fork
Fork box
curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/fork \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "type": "box.forking",
  "id": "bx_abcdef23",
  "status": "forking",
  "box": {
    "id": "bx_abcdef23",
    "name": "Box fork",
    "state": "provisioning",
    "desktopAvailable": false,
    "snapshotAvailable": false
  }
}

Authorizations

​
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.

Path Parameters

​
boxId
string
required

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

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

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