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

Authorizations

Authorization
string
header
required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Path Parameters

environmentId
string<uuid>
required

Body

application/json

Repoint active boxes 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 box (agent) ids. Omit to upgrade all of the caller's active boxes that are on an older version of this environment.

Response

Upgrade result counts.

success
boolean
required
upgraded
integer
required
failed
integer
required