Skip to main content
POST
Upgrade sandboxes to an environment's latest version

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentId
string<uuid>
required

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

Repoint active sandboxes to the environment's latest version, scrubbing any owner secrets the new version drops and hot-pushing the new config.

agentIds
string[]

Restrict the upgrade to these sandbox (agent) ids. Omit to upgrade all of the caller's active sandboxes that are on an older version of this environment.

Response

Upgrade result counts.

success
boolean
required
upgraded
integer
required
failed
integer
required
upgradedLive
integer

Running sandboxes that received the new configuration now.

upgradedStopped
integer

Stopped sandboxes moved to the latest version; they pick it up when they next resume.

latestVersionId
string

Id of the version the sandboxes were moved to.