Update environment
Authorizations
A Recursion API key, created in the console under API keys.
Headers
Replay-protection key in an organization-wide namespace shared by keyed mutations. It must contain 1 to 256 visible ASCII characters and be sent as exactly one header value. Request identity is the exact HTTP method, escaped path, raw query, and raw body bytes. For the legacy automation-run route only, the historical fingerprint ignores top-level JSON formatting and object-key order and removes the retired top-level idempotency_key field. The same request replays the original successful response; any different request returns 409 idempotency_conflict, and an active matching request returns 409 idempotency_in_progress. Completed receipts are retained for approximately 24 hours, pending claims may be reclaimed after approximately 1 hour, and no deduplication is guaranteed after expiry.
1 - 256^[!-~]+$Path Parameters
Environment id (UUID) as returned by createEnvironment or listEnvironments.
Body
Writable fields for a partial environment update. Omitted fields keep their stored values; null is not accepted.
Whether the environment boots the shared interactive browser display.
Provider-specific overflow settings. Omit to keep them; send {} to clear them.
Free-text note about what this environment provides. Send an empty string to clear it.
Plaintext environment variables. Omit to keep them; send {} to clear them.
Required when a Runs PATCH changes or bypasses a nonempty network policy, or enables privileged Docker. Copy network_policy and privileged from the last environment read; a stale snapshot is rejected.
Port inside the sandbox to expose over HTTP; 0 exposes nothing.
x >= 0Seconds of inactivity after which a running sandbox is stopped; 0 uses the provider default.
x >= 0Container image the sandbox boots. Send an empty string to return to the provider default.
Caller-owned key/value data. Omit to keep it; send {} to clear it.
Files staged into the sandbox workspace. Omit to keep them; send [] to clear them.
Human-readable label shown wherever environments are listed.
Runs egress rules. Omit to keep them; send {} for unrestricted egress. A nonempty policy requires GKE placement.
Whether the Runs sandbox may use privileged Docker. Omit to retain the saved value, or send false to disable it.
Sandbox runtime that executes the session, chosen from the sandbox providers catalog.
Size in GiB of the persistent workspace volume; 0 uses the provider default.
x >= 0Caller-sized CPU and memory, accelerator, lifetime, and placement constraints. Send an empty object to return to provider sizing defaults.
Who may use the environment. Defaults to organization, meaning it is shared across the owning organization.
Environment variable name to secret-manager reference. Omit to keep them; send {} to clear them.
Setup script run after the sandbox is provisioned and before the agent starts. Send an empty script to clear it.
Seconds a stopped sandbox is retained before deletion; 0 uses the provider default.
x >= 0Response
A sandbox environment a session executes in: its provider, resources, mounts, setup steps and idle/delete lifecycle. Created and started independently of any session.
A sandbox environment a session executes in: its provider, resources, mounts, setup steps and idle/delete lifecycle. Created and started independently of any session.
Whether this environment boots the shared interactive Chromium display used by the computer and human-handoff tools. The server projects this to http_port 6901.
Server-assigned RFC 3339 timestamp of when the environment was created.
Server-assigned id of the environment; pass it when starting a session that should run in this sandbox.
Human-readable label shown wherever environments are listed.
Organization that owns the environment. Server-assigned from the caller's credentials.
Sandbox runtime that executes the session, chosen from the sandbox providers catalog.
Caller-sized CPU and memory for CPU environments, or one exclusive accelerator with service-owned limits of 8,000 millicores (8 vCPU) and 32,768 MiB (32 GiB) of memory for GPU environments, plus lifetime and placement constraints.
Who may use the environment. Defaults to organization, meaning it is shared across the owning organization.
Setup script run after the sandbox is provisioned and before the agent starts.
Server-assigned RFC 3339 timestamp of the most recent update to the environment.
Provider-specific overflow settings this schema does not model. Passed to the provider unchanged.
Free-text note about what this environment provides.
Plaintext environment variables exported in the sandbox. They become the whole container environment, including the runner entrypoint's, so PATH is refused (env_vars.PATH): managed images select /workspace/.venv themselves. A Runs session using one-time setup after its runner changes also refuses startup-hook names such as BASH_ENV, HOME, PYTHONPATH, and LD_PRELOAD; re-test to capture a compatible image instead. Never put secrets here; use secrets instead. On update, omit to keep the current variables; send {} to clear them.
Port inside the sandbox to expose over HTTP for services the agent starts; 0 exposes nothing.
x >= 0Seconds of inactivity after which a running sandbox is stopped; 0 uses the provider default. A computer-enabled environment requires 0 or at least 600 seconds so its five-minute handoff heartbeat arrives before idle-stop.
x >= 0Container image the sandbox boots. Omit to use the provider's default image. For the Agent runner provider only the deployment's own runner repository or a sibling published beside it (for example rma-runner-recursion) is accepted, and it must be omitted when an accelerator is requested, which always boots the platform's GPU runner. Customize the sandbox itself with setup.script.
Caller-owned key/value data stored with the environment and returned unchanged.
Files or objects staged into the sandbox workspace when it is created. On update, omit to keep the current mounts; send [] to clear them.
Runs egress rules. On update, omission keeps the stored policy. Changing from a non-Runs provider to Runs with an absent or {} stored policy requires an explicit network_policy: {"version":"v1","rules":[]} for deny-all or {} for unrestricted egress. A nonempty policy requires GKE; with explicit non-GKE placement, send {} for unrestricted egress or change placement to GKE. Send {} to clear a policy. Runs responses always include network_policy; {} means unrestricted.
Whether a Runs sandbox may use privileged Docker. Independent of network_policy; omit on update to retain the saved value, or send false to disable it. New Runs environments and transitions from another provider default to false. The first edit to a legacy Runs environment persists its existing effective setting explicitly. Compute creation fails closed unless Agent Service can enforce the requested combination.
Size in GiB of the persistent workspace volume; 0 uses the provider default.
x >= 0Environment variable name to secret-manager reference. References only, never plaintext values; the runtime resolves them at start. The one-time Runs setup fallback applies the same startup-hook name restriction to secrets and vault-injected variables. On update, omit to keep the current references; send {} to clear them.
RFC 3339 timestamp of the last setup script change. Server-assigned.
User who last changed the setup script. Server-assigned.
Server-owned verdict on the setup script: whether a manual setup run has proven this exact configuration on real compute. Read status and stale before starting sessions; read last_run.hint first when status is failed.
Advisory findings about the setup script (bash -lc wrapping, curl | sh, unpinned installs, ambiguous system Python, PATH replacement, or non-persistent shell activation), plus legacy_setup_discarded when the stored setup predates setup.script and is not run. Never block a save; computed on read.
Seconds a stopped sandbox is retained before deletion; 0 uses the provider default.
x >= 0