Skip to main content
PATCH
Patch an environment
Partial update: only the fields you send change. Send a field as null to clear it, for example vault_id: null to unbind a vault. The merged result is validated like a full update. Returns the updated environment object.

Path parameters

string
required
The environment’s id (e.g. wide-browser or myorg/wide-browser). Slash-containing identifiers are supported.

Request body

Any subset of these environment fields: host, start_url, headless, session_id, mode, lazy, settle_s, vault_id, browser_profile_id, use_default_browser_profile, persist_browser_profile, network, screenshot_max_width (desktop environments only), and image (emulator image, Android environments only). id and kind are not patchable.

Examples

Bind a vault, leaving the rest of the spec untouched:

Errors