Skip to main content
POST
Create a sandbox environment

Authorizations

Authorization
string
header
required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Query Parameters

org
string

Billing wallet for this request: an organization you belong to, by id (team_…) or by name as GET /orgs lists it (case-insensitive), or personal. Omitted, the account's active wallet applies (PATCH /orgs/active; personal until set). Two organizations sharing the name answer 409 ambiguous_org and need the id. Sandboxes and snapshots stay creator-private. On /environments routes, only this query parameter selects the organization's shared environments; the X-Boat-Org header and the active wallet do not apply there. Members read them, owners and admins change them.

Body

application/json
name
string
required

Unique environment name. Letters, numbers, dot, dash, underscore; max 64 chars.

Maximum string length: 64
Pattern: ^[a-zA-Z0-9._-]+$
Example:

"customer-demos"

Response

Environment created; full list returned.

environments
object[]
required
ok
boolean
Example:

true

type
string
Allowed value: "environments.list"