Skip to main content
PUT
Update a Box environment

Authorizations

Authorization
string
header
required

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

Path Parameters

environmentId
string<uuid>
required

Environment id returned by GET /environments.

Body

application/json

Rename, set-default, and/or edit flags and contents. Any flag or content change mints a new immutable version; existing boxes are not touched until you call upgrade.

name
string

New environment name.

isDefault
boolean

Set to true to make this the default environment (clears the flag on the previous default).

safeForThirdParties
boolean
passGithub
boolean
passSecrets
boolean
passBoxCredentials
boolean
passAgentsCredentials
boolean
envContents
string

Full .env-style content for the new version.

secretFiles
object[]
repositories
object[]

Full replacement of the version's repository selection. Each item selects one repository by its internal databaseId (from GET /repos).

Response

Updated environment.

success
boolean
required
environment
object | null

A named Box environment. All flags/contents reflect the latest version.