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

# Get an Environment

> Returns one visible CMA-compatible Environment by its env_ identity.

Checkfu support posture: alpha; hosted. Required evidence journey: sandbox-conformance. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities.



## OpenAPI

````yaml /openapi.json get /v1/environments/{environment_id}
openapi: 3.1.0
info:
  title: Checkfu API
  version: '2026-08-27'
  description: >-
    Authentication is declared per operation: API-key, runtime, or connector
    bearer; Automation signature; or credential-free pairing redemption. Every
    general Checkfu REST request requires the dated `Checkfu-Version` header
    (one of: 2026-08-27); the three MCP JSON-RPC transports use
    `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth
    callback carries neither Checkfu header. API keys resolve one Workspace
    without a request selector; authenticated responses identify it with
    `Checkfu-Workspace-Id`.
servers:
  - url: https://api.checkfu.com
security:
  - bearerAuth: []
tags:
  - name: organizations
  - name: sourceRepositories
  - name: tenants
  - name: workspaces
  - name: principals
  - name: principalGroups
  - name: principalAccessCredentials
  - name: apiKeys
  - name: agents
  - name: harnesses
  - name: harnessRuntime
  - name: sandboxProfiles
  - name: computerProfiles
  - name: permissionAssignments
  - name: actionPolicies
  - name: files
  - name: memoryStores
  - name: dreams
  - name: modelCredentials
  - name: modelRoutingProfiles
  - name: blueprintInstallations
  - name: toolSources
  - name: skills
  - name: skillSources
  - name: agentSources
  - name: skillProposals
  - name: instructionProposals
  - name: catalog
  - name: concepts
  - name: support
  - name: connections
  - name: connectionVaults
  - name: connectionAssignments
  - name: connectedRuntimes
  - name: projects
  - name: collaboration
  - name: automationGraphs
  - name: automations
  - name: actionApprovals
  - name: standingApprovals
  - name: usage
  - name: models
  - name: outcomes
  - name: budgets
  - name: billing
  - name: sessions
  - name: audit
  - name: sessionExports
  - name: runs
  - name: runnerPools
  - name: transcripts
  - name: sessionWatches
  - name: webhookEndpoints
  - name: integrationGateway
  - name: agentDeployments
  - name: workEnvironments
  - name: computers
  - name: computerScreens
  - name: computerBrowserObservations
  - name: computerBrowserActions
  - name: environments
  - name: vaults
  - name: apiMcp
  - name: a2a
paths:
  /v1/environments/{environment_id}:
    get:
      tags:
        - environments
      summary: Get an Environment
      description: >-
        Returns one visible CMA-compatible Environment by its env_ identity.


        Checkfu support posture: alpha; hosted. Required evidence journey:
        sandbox-conformance. Deployment-specific readiness and the latest proven
        release are available from GET /v1/support/capabilities.
      operationId: environments.getEnvironment
      parameters:
        - name: environment_id
          in: path
          schema:
            $ref: '#/components/schemas/EnvironmentId'
          required: true
        - name: checkfu-version
          in: header
          schema:
            type: string
            enum:
              - '2026-08-27'
          required: true
        - name: checkfu-beta
          in: header
          schema:
            $ref: '#/components/schemas/ManagedAgentsBetaHeaderValue'
          required: true
      responses:
        '200':
          description: BetaEnvironment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BetaEnvironment'
          headers:
            checkfu-workspace-id:
              description: The Workspace resolved from the authenticated bearer credential.
              required: true
              schema:
                $ref: '#/components/schemas/WorkspaceId'
        '400':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - validation.malformed
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#validation-malformed
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    required:
                      - type
                      - message
                      - more
                    additionalProperties: false
                additionalProperties: false
        '401':
          description: Typed Checkfu wire error
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - auth.invalid_key
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#auth-invalid-key
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '403':
          description: >-
            The organization, tenant, or workspace backing this key is
            administratively disabled. | Deployment governance or retention
            policy denied the request.
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    required:
                      - error
                    properties:
                      error:
                        type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - auth.disabled_tenancy
                          message:
                            type: string
                          more:
                            type: string
                            enum:
                              - >-
                                https://docs.checkfu.com/reference/errors#auth-disabled-tenancy
                            description: >-
                              Stable public documentation and remedy for this
                              error type.
                        required:
                          - type
                          - message
                          - more
                        additionalProperties: false
                    additionalProperties: false
                  - $ref: '#/components/schemas/PolicyDeniedError'
        '404':
          description: >-
            The requested resource does not exist in the resolved deployment
            boundary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationNotFoundError'
        '429':
          description: Typed Checkfu wire error
          headers:
            retry-after:
              description: >-
                Delay in seconds for rate limits or deployment quotas with a
                known release or UTC reset boundary
              required: false
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                properties:
                  error:
                    type: object
                    required:
                      - type
                      - message
                      - more
                    properties:
                      type:
                        type: string
                        enum:
                          - budget.exceeded
                      message:
                        type: string
                      more:
                        type: string
                        enum:
                          - >-
                            https://docs.checkfu.com/reference/errors#budget-exceeded
                        description: >-
                          Stable public documentation and remedy for this error
                          type.
                    additionalProperties: false
                additionalProperties: false
        '500':
          description: >-
            An unexpected internal failure occurred; the message contains an
            opaque incident reference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeInternalError'
      security:
        - bearerAuth: []
components:
  schemas:
    EnvironmentId:
      type: string
      allOf:
        - pattern: ^env_[0-9a-f]{32}$
    ManagedAgentsBetaHeaderValue:
      type: string
    BetaEnvironment:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/EnvironmentId'
        archived_at:
          anyOf:
            - type: string
            - type: 'null'
        config:
          $ref: '#/components/schemas/BetaEnvironmentConfig'
        created_at:
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
        metadata:
          $ref: '#/components/schemas/ResourceMetadata'
        name:
          type: string
        type:
          type: string
          enum:
            - environment
        updated_at:
          type: string
        scope:
          $ref: '#/components/schemas/BetaEnvironmentScope'
      required:
        - id
        - archived_at
        - config
        - created_at
        - description
        - metadata
        - name
        - type
        - updated_at
      additionalProperties: false
    WorkspaceId:
      type: string
      allOf:
        - pattern: ^wrkspc_[0-9a-f]{32}$
    PolicyDeniedError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - policy.denied
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#policy-denied
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: Deployment governance or retention policy denied the request.
    ValidationNotFoundError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - validation.not_found
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#validation-not-found
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        The requested resource does not exist in the resolved deployment
        boundary.
    RuntimeInternalError:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - runtime.internal
            message:
              type: string
            more:
              type: string
              enum:
                - https://docs.checkfu.com/reference/errors#runtime-internal
              description: Stable public documentation and remedy for this error type.
          required:
            - type
            - message
            - more
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: >-
        An unexpected internal failure occurred; the message contains an opaque
        incident reference.
    BetaEnvironmentConfig:
      anyOf:
        - $ref: '#/components/schemas/BetaCloudConfig'
        - $ref: '#/components/schemas/BetaSelfHostedConfig'
    ResourceMetadata:
      type: object
      additionalProperties:
        type: string
        allOf:
          - maxLength: 512
      allOf:
        - propertyNames:
            type: string
            allOf:
              - minLength: 1
              - maxLength: 64
        - maxProperties: 16
          description: at most 16 correlation pairs with keys of 1 to 64 characters
    BetaEnvironmentScope:
      type: string
      enum:
        - organization
        - account
    BetaCloudConfig:
      type: object
      properties:
        type:
          type: string
          enum:
            - cloud
        networking:
          anyOf:
            - $ref: '#/components/schemas/BetaUnrestrictedNetwork'
            - $ref: '#/components/schemas/BetaLimitedNetwork'
        packages:
          $ref: '#/components/schemas/BetaPackages'
      required:
        - type
        - networking
        - packages
      additionalProperties: false
    BetaSelfHostedConfig:
      type: object
      properties:
        type:
          type: string
          enum:
            - self_hosted
      required:
        - type
      additionalProperties: false
    BetaUnrestrictedNetwork:
      type: object
      properties:
        type:
          type: string
          enum:
            - unrestricted
      required:
        - type
      additionalProperties: false
    BetaLimitedNetwork:
      type: object
      properties:
        type:
          type: string
          enum:
            - limited
        allow_mcp_servers:
          type: boolean
        allow_package_managers:
          type: boolean
        allowed_hosts:
          type: array
          items:
            type: string
      required:
        - type
        - allow_mcp_servers
        - allow_package_managers
        - allowed_hosts
      additionalProperties: false
    BetaPackages:
      type: object
      properties:
        type:
          type: string
          enum:
            - packages
        apt:
          $ref: '#/components/schemas/Arrays_48'
        cargo:
          $ref: '#/components/schemas/Arrays_48'
        gem:
          $ref: '#/components/schemas/Arrays_48'
        go:
          $ref: '#/components/schemas/Arrays_48'
        npm:
          $ref: '#/components/schemas/Arrays_48'
        pip:
          $ref: '#/components/schemas/Arrays_48'
      required:
        - apt
        - cargo
        - gem
        - go
        - npm
        - pip
      additionalProperties: false
    Arrays_48:
      type: array
      items:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````