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

# Get environment

> Returns a single environment by id. Includes `cascade_preview` (counts of api_key / alert / deployment / template_snapshot rows that would be deleted on env delete — see FR-090) and `in_flight_saga_id` (id of the most-recent pending/snapshotting/deploying saga deployment row, or null).



## OpenAPI

````yaml /openapi.yaml get /v1/environments/{id}
openapi: 3.0.3
info:
  contact:
    email: hello@agentmark.co
    url: https://docs.agentmark.co
  description: >-
    The AgentMark Gateway API lets you ingest traces, create scores, and
    retrieve prompt templates programmatically.


    Most developers should use the [AgentMark SDK](/introduction/overview) for
    integration.

    The REST API is for cases where you need direct HTTP access or are building
    a custom integration.


    Versioning: every endpoint is prefixed with `/v1/`. Breaking changes ship
    under a new version prefix (`/v2/`, etc.) with a 90-day-minimum deprecation
    window — see [API versioning & stability](/api-reference/versioning) for the
    full policy on what constitutes a breaking vs. additive change.
  title: AgentMark Gateway API
  version: '1.0'
servers:
  - description: Production (AgentMark Cloud)
    url: https://api.agentmark.co
  - description: Local dev server (`npx @agentmark-ai/cli dev`)
    url: http://localhost:9418
security:
  - AppId: []
    BearerAuth: []
tags:
  - description: Ingest, query, and export OpenTelemetry trace data.
    name: Traces
  - description: >-
      Coding-agent session ingest (outerlayer sync) and content-addressed
      session images.
    name: Agents
  - description: Query individual spans across traces.
    name: Spans
  - description: Create, retrieve, list, and delete score records for spans and traces.
    name: Scoring
  - description: Structured-filter search across observability resources.
    name: Search
  - description: Retrieve the effective synced project configuration.
    name: Config
  - description: List and retrieve datasets.
    name: Datasets
  - description: Query server feature availability.
    name: Capabilities
  - description: Per-model LLM pricing data. Public, unauthenticated.
    name: Pricing
  - description: >-
      Create, list, and revoke tenant API keys. Plaintext returned exactly once
      at creation.
    name: API Keys
  - description: >-
      List and retrieve score configuration definitions from the synced project
      config.
    name: Score Configs
  - description: >-
      Trigger and inspect managed deployments. POST returns 202; deployments run
      asynchronously and progress is observed via GET.
    name: Deployments
  - description: >-
      Per-app named environments (e.g. `dev`, `prod`). CRUD for env lifecycle;
      promote/rollback routes land alongside in this group as feature 054 lands
      the saga.
    name: Environments
  - description: >-
      App CRUD — the top-level tenant entity every other resource hangs off.
      Lets a headless agent provision an app without the dashboard.
    name: Apps
  - description: Service health checks.
    name: Health
paths:
  /v1/environments/{id}:
    get:
      tags:
        - Environments
      summary: Get environment
      description: >-
        Returns a single environment by id. Includes `cascade_preview` (counts
        of api_key / alert / deployment / template_snapshot rows that would be
        deleted on env delete — see FR-090) and `in_flight_saga_id` (id of the
        most-recent pending/snapshotting/deploying saga deployment row, or
        null).
      operationId: get-environment
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    properties:
                      cascade_preview:
                        properties:
                          alert_count:
                            minimum: 0
                            type: integer
                          api_key_count:
                            minimum: 0
                            type: integer
                          deployment_count:
                            minimum: 0
                            type: integer
                          template_snapshot_count:
                            minimum: 0
                            type: integer
                        required:
                          - api_key_count
                          - alert_count
                          - deployment_count
                          - template_snapshot_count
                        type: object
                      created_at:
                        type: string
                      created_by_id:
                        nullable: true
                        type: string
                      current_commit_sha:
                        nullable: true
                        type: string
                      current_version:
                        minimum: 0
                        type: integer
                      epoch:
                        type: integer
                      fly_app_name:
                        nullable: true
                        type: string
                      id:
                        format: uuid
                        type: string
                      in_flight_saga_id:
                        format: uuid
                        nullable: true
                        type: string
                      is_default:
                        type: boolean
                      is_ephemeral:
                        type: boolean
                      latest_deployment_id:
                        format: uuid
                        nullable: true
                        type: string
                      machine_status:
                        enum:
                          - active
                          - cleaned_up
                          - none
                        type: string
                      name:
                        type: string
                      source_pr_number:
                        nullable: true
                        type: integer
                      updated_at:
                        nullable: true
                        type: string
                    required:
                      - id
                      - name
                      - is_default
                      - current_version
                      - latest_deployment_id
                      - current_commit_sha
                      - fly_app_name
                      - machine_status
                      - is_ephemeral
                      - source_pr_number
                      - epoch
                      - created_at
                      - created_by_id
                      - updated_at
                      - in_flight_saga_id
                      - cascade_preview
                    type: object
                required:
                  - data
                type: object
          description: Environment detail with cascade preview.
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Invalid request parameters (validation failed).
        '401':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Missing or invalid API key.
        '403':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Caller lacks 'environment.read' permission.
        '404':
          content:
            application/json:
              schema:
                properties:
                  error:
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Environment not found.
components:
  securitySchemes:
    AppId:
      description: >-
        Application ID for tenant scoping. X-Outerlayer-App-Id is accepted as an
        equivalent header.
      in: header
      name: X-Agentmark-App-Id
      type: apiKey
    BearerAuth:
      description: API key (sk_agentmark_*)
      scheme: bearer
      type: http

````