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

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