Skip to main content
Version: v5.7.0

Environment

Included from Basic tier

An environment is the estate node between a project and its assets — "/projects/web/environments/dev" — owning its own properties and settings documents that merge into everything beneath it. Create, update (archive/restore included) and soft-delete follow the node-write semantics: a field left unset preserves the stored value, and deleting hides the whole subtree reversibly. An environment also carries the agent governance attribute release_stage_floor — the release stage an agent must hold to act beneath it (opschain nodes update <path> --release-stage-floor <rung>). Served by the v2 EnvironmentService (ListEnvironments, GetEnvironment, CreateEnvironment, UpdateEnvironment, DeleteEnvironment).

Environment​

Environment is the typed environment read shape.

FieldTypeMeaning
archivedbooleanWhether the environment is archived. Toggled through UpdateEnvironment; a no-op toggle, or archiving while changes are active, refuses.
changes_executebooleanMay the caller execute changes under this node (execute on /changes).
codestringThe record's code.
created_bystringUsername of the creating identity.
descriptionstring"" when never set.
idstringThe record's identity.
maintenanceNodeMaintenanceBadgeThe active-maintenance badge; unset while the node is open (the v1 maintenance attribute).
namestringDisplay name.
node_pathstringThe environment's node path, e.g. "/projects/web/environments/dev".
project_codestringThe owning project's code.
properties_idstringThe environment's owned properties/settings document ids.
release_stage_floorstringThe agent release-stage floor: a rung of the estate's stage ladder, or "" for none. Set through UpdateEnvironment.release_stage_floor (needs packs:agent-governance; "" clears it; a name that is not a rung refuses). While set, every action, run and governed read an agent targets under this environment is refused with AGENT_RELEASE_STAGE_BELOW_FLOOR unless the agent's enrolled release sits at or above the rung — an agent without a release is always refused. See opschain docs agent-releases ("Where a stage may act").
settings_idstringThe environment's owned settings document id (the pair of properties_id).

EnvironmentFilter​

EnvironmentFilter is the typed environments predicate vocabulary.

FieldTypeMeaning
archivedbooleanKeep only archived (true) or unarchived (false) environments; unset keeps both (the v1 filter[archived_eq] contract).
  • opschain docs resources/project — the owning node.
  • opschain docs resources/asset — the templated nodes beneath it.
  • opschain docs resources/properties — the owned documents and how they merge.
  • opschain docs maintenance-windows — what the maintenance badge reports.
  • opschain docs agent-releases — the stage ladder the release_stage_floor names and how the floor is enforced.