Update an environment
Environments
Update an environment
Replace the configuration of an environment in your catalog.
PUT
Update an environment
Updates an existing environment. This is a full replacement of the Browser spec. The
id must match the URL identifier: renames are not supported.
Returns the updated Environment object.
Path parameters
The environment’s
id (e.g. wide-browser or myorg/wide-browser). Slash-containing identifiers are supported.Request body
A full replacement of the Browser spec. Theid in the body must equal the URL identifier. Any field you omit is reset to its default, not preserved, including vault_id: omitting it unbinds any vault currently attached. To change individual fields without resending the rest, use Patch instead.
The example below binds a vault while keeping the rest of the spec.
Examples
Response
Errors
| Status | Cause |
|---|---|
400 | The id in the body does not match the URL identifier (renames are not supported). |
403 | The environment is reserved (h/) and read-only. |
404 | Environment not found or you don’t have access. |
422 | Body fails validation; common cases: invalid id shape, missing required field. |