Skip to main content
POST
Create Web Box

Authorizations

Authorization
string
header
required

Use a Continuous API key. Send it in the Authorization header as a Bearer token.

Headers

Idempotency-Key
string

Optional key for retrying this create safely. A retry with the same key and request returns the same Web Box. The same key with a different request returns 409 idempotency_conflict.

Maximum string length: 256

Body

application/json
snapshot_id
string
required

A ready Web Box Snapshot of the workspace or the catalog.

Pattern: ^wbs_[0-9A-HJKMNP-TV-Z]{26}$
include_sample_data
boolean

Start with the Snapshot's sample data: a realistic account loaded on top of its seed before the first request. Defaults to false, a brand-new workspace. Requires a Snapshot that carries sample data; see its composition.

metadata
any

Customer JSON metadata, up to 16 KiB and 64 nesting levels.

name
string

Name for the Web Box. Omission generates a name.

Maximum string length: 128

Response

Accepted

created_at
string<date-time>
required

Web Box creation time.

error
object | null
required

Why its last run stopped without a stop request, or null.

id
string
required

Web Box ID.

Pattern: ^wbx_[0-9A-HJKMNP-TV-Z]{26}$
include_sample_data
boolean
required

Whether the Web Box started with the Snapshot's sample data.

metadata
any
required

Customer JSON metadata, or null.

name
string
required

Web Box name. The ID is its identity, and names need not be unique.

Maximum string length: 128
snapshot_id
string
required

The Web Box Snapshot it started from.

Pattern: ^wbs_[0-9A-HJKMNP-TV-Z]{26}$
status
enum<string>
required

starting while its runtime boots; running while it serves its app; stopping while it saves its state; stopped when it holds no runtime. A start resumes the saved state.

Available options:
starting,
running,
stopping,
stopped
url
string
required

URL that opens the Web Box's app, at a host of its own.