> ## Documentation Index
> Fetch the complete documentation index at: https://docs.replicas.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get effective environment

> Returns the environment's configuration folded over its chain (Global, then each ancestor, then the environment itself) with provenance for every variable, file, MCP, skill, skill registry, plugin, and secret-sync connection. System prompts are listed in the order they're combined. Values from environments you can't read are blanked and flagged `masked`.



## OpenAPI

````yaml /openapi.json get /v1/environments/{environment_id}/effective
openapi: 3.1.0
info:
  title: Replicas API
  version: 2.0.0
  description: >-
    Create and control workspaces, and manage the environments, automations, and
    learnings they run with.
servers:
  - url: https://api.replicas.dev
    description: Production API
security:
  - apiKey: []
tags:
  - name: Replica
    description: >-
      A replica is a Replicas workspace: a cloud sandbox where a coding agent
      works on your repositories.
  - name: Chats
    description: Manage the agent chats inside a replica.
  - name: Message queue
    description: Messages waiting for the agent to finish its turn.
  - name: Commands and terminals
    description: Run commands and open shells in a replica.
  - name: Pull requests
    description: Inspect and act on pull requests a replica opened.
  - name: Previews
    description: Public URLs for ports in a replica.
  - name: Canvas
    description: Plans, reports, and other files agents produce.
  - name: Sharing
    description: Add replicas to members' Shared view.
  - name: Environments
    description: >-
      Environments define what a workspace starts with. The `global` environment
      applies to every workspace.
  - name: Environment variables
    description: Variables injected into workspaces.
  - name: Environment files
    description: Files written into workspaces.
  - name: Environment skills
    description: Agent skills installed into workspaces.
  - name: Environment MCPs
    description: MCP servers available to workspace agents.
  - name: Hooks
    description: Scripts that run when warm pool snapshots build and when workspaces start.
  - name: Warm pools
    description: Pre-built workspaces that start faster.
  - name: Automations
    description: Run agents on schedules and events.
  - name: Repositories
    description: Repositories and repository sets connected to the organization.
  - name: Learnings
    description: Organization skills every workspace agent loads.
  - name: Agent credentials
    description: >-
      API keys and endpoints that coding agents use. Connect Claude, Codex, and
      Muse subscriptions with the CLI.
  - name: Plugins
    description: Connect integrations that workspace agents can use.
  - name: Organization
    description: Who you are and who is in your organization.
  - name: Media
    description: Screenshots, recordings, and other files workspaces produce.
  - name: Slack
    description: Route Slack threads to workspaces.
  - name: Workspace identity
    description: OIDC keys for verifying workspace identity tokens.
paths:
  /v1/environments/{environment_id}/effective:
    get:
      tags:
        - Environments
      summary: Get effective environment
      description: >-
        Returns the environment's configuration folded over its chain (Global,
        then each ancestor, then the environment itself) with provenance for
        every variable, file, MCP, skill, skill registry, plugin, and
        secret-sync connection. System prompts are listed in the order they're
        combined. Values from environments you can't read are blanked and
        flagged `masked`.
      operationId: getEffectiveEnvironment
      parameters:
        - name: environment_id
          in: path
          required: true
          description: Environment UUID.
          schema:
            type: string
        - $ref: '#/components/parameters/ApiVersion'
      responses:
        '200':
          description: Effective configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EffectiveEnvironmentResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ApiVersion:
      name: X-Replicas-Api-Version
      in: header
      description: >-
        API version. `2026-10-07` returns `snake_case` responses. See
        [versioning](/features/api#versioning).
      required: false
      schema:
        type: string
        enum:
          - '2026-10-07'
  schemas:
    EffectiveEnvironmentResponse:
      type: object
      properties:
        chain:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              name:
                type: string
              user_id:
                type:
                  - string
                  - 'null'
              is_global:
                type: boolean
        system_prompts:
          type: array
          items:
            type: object
            properties:
              environment_id:
                type: string
                format: uuid
              system_prompt:
                type: string
        repository:
          type: object
          properties:
            repository_id:
              type:
                - string
                - 'null'
            repository_set_id:
              type:
                - string
                - 'null'
            origin_environment_id:
              type:
                - string
                - 'null'
        memory:
          type: object
          properties:
            read:
              type: boolean
            read_origin_environment_id:
              type:
                - string
                - 'null'
            write:
              type: boolean
            write_origin_environment_id:
              type:
                - string
                - 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/EffectiveEnvironmentItem'
      required:
        - chain
        - system_prompts
        - repository
        - memory
        - items
    EffectiveEnvironmentItem:
      type: object
      properties:
        kind:
          type: string
          enum:
            - variable
            - file
            - mcp
            - skill
            - skills_registry
            - plugin
            - integration
        key:
          type: string
        origin_environment_id:
          type: string
          format: uuid
          description: >-
            Environment whose record is returned: the winner, or the hidden
            ancestor for `excluded`.
        status:
          type: string
          enum:
            - own
            - inherited
            - overridden
            - excluded
        inherited_from_environment_id:
          type:
            - string
            - 'null'
          format: uuid
        locked:
          type: boolean
          description: >-
            An ancestor locked this variable, so it can't be overridden or
            excluded here.
        masked:
          type: boolean
        record:
          type: object
          description: >-
            The variable, file, MCP, skill, registry, plugin connection, or
            `{environment_id, provider}` record.
      required:
        - kind
        - key
        - origin_environment_id
        - status
        - inherited_from_environment_id
        - locked
        - masked
        - record
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type:
            - string
            - 'null'
          description: Additional error details
        code:
          type: string
          description: Machine-readable error code when available
      required:
        - error
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden - The authenticated account cannot access this resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Organization or personal API key from **Settings → API Keys**.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.