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

# List a project's environments

> The project environments saved in the project. Archived environments are excluded unless `includeArchived=true` — you need that to find one to restore.



## OpenAPI

````yaml /reference/openapi.json get /projects/{projectId}/environments
openapi: 3.1.0
info:
  title: MCPJam API
  version: 1.0.0-preview
  description: >-
    Programmatic access to MCP servers saved in your MCPJam projects — live
    diagnostics (validate, inspect, export) and operations: call tools, render
    prompts, run eval suites asynchronously and poll their results, and import
    OAuth tokens.


    **The API is in preview**: the surface may change while we finish the
    design. Error `code` values are stable; error `message` strings are not.
    Write clients that ignore unknown response fields.
  contact:
    name: MCPJam
    url: https://github.com/MCPJam/inspector/issues
servers:
  - url: https://app.mcpjam.com/api/v1
    description: Hosted MCPJam
security:
  - bearerAuth: []
tags:
  - name: Hosts
    description: >-
      Project hosts: named model + capability profiles you run chats and eval
      suites against.
  - name: Environments
    description: >-
      Project environments: named, live-editable execution bundles (one host, an
      optional standalone server group, optionally pinned skills and plugin
      versions) that eval suites and journeys run against. Distinct from Sandbox
      images, which are Computer base images. Reads require project membership;
      every write requires project admin.
  - name: Sandbox images
    description: >-
      Custom Computer images: a digest-pinned Dockerfile built into an immutable
      image your project's computers boot from.
  - name: Server diagnostics
    description: Connect-level health checks against a saved MCP server.
  - name: Primitives
    description: 'The server''s MCP primitives: tools, prompts, and resources.'
  - name: Export
    description: Full-server snapshots for diffing and CI.
  - name: Execution
    description: 'Run the server''s primitives: call tools, render prompts.'
  - name: Eval runs
    description: >-
      Asynchronous eval suite runs: create with 202, poll status, iterations,
      and traces.
  - name: OAuth
    description: 'Bring-your-own OAuth: import externally obtained tokens for a server.'
  - name: Chatboxes
    description: >-
      Read-only access to the chatboxes published from a project: listing,
      settings, attached servers, and share links.
  - name: Catalog
    description: >-
      Discover the resources the other routes operate on: your account,
      projects, servers, eval suites, and chat sessions.
  - name: Tunnels
    description: >-
      Relay tunnels that expose local MCP servers through a public URL,
      registered as first-class project servers (the `mcpjam tunnel` CLI flow).
paths:
  /projects/{projectId}/environments:
    get:
      tags:
        - Environments
      summary: List a project's environments
      description: >-
        The project environments saved in the project. Archived environments are
        excluded unless `includeArchived=true` — you need that to find one to
        restore.
      operationId: listEnvironments
      parameters:
        - $ref: '#/components/parameters/projectId'
        - name: includeArchived
          in: query
          required: false
          description: Include archived environments.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: The project's environments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectEnvironmentPage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        '502':
          $ref: '#/components/responses/ServerUnreachable'
components:
  parameters:
    projectId:
      name: projectId
      in: path
      required: true
      description: ID of the hosted project that contains the server.
      schema:
        type: string
  schemas:
    ProjectEnvironmentPage:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ProjectEnvironment'
    ProjectEnvironment:
      type: object
      description: >-
        A project environment: a named, live-editable execution bundle that eval
        suites and journeys run against.
      required:
        - id
        - projectId
        - name
        - hostId
        - revision
        - archived
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
        projectId:
          type: string
        name:
          type: string
          description: Unique among the project's live (non-archived) environments.
        description:
          type: string
        hostId:
          type: string
          description: The host this environment runs against.
        serverAttachmentId:
          type: string
          description: >-
            Present only when the environment pins a standalone server group;
            otherwise the host config's own servers apply.
        skillSelection:
          $ref: '#/components/schemas/EnvironmentSkillSelection'
        pluginVersionIds:
          type: array
          items:
            type: string
          description: >-
            Pinned plugin VERSION IDs. Narrow by design: the plugin must be
            installed and enabled, the version must be `ready`, at most one
            version per plugin may be pinned, and none of its skills may carry
            supporting files. Not a general-purpose plugin list.
        revision:
          type: integer
          description: >-
            Optimistic-concurrency counter. Pass this back as `expectedRevision`
            on the next write; if it no longer matches, the write is rejected
            with 409 instead of overwriting a concurrent edit.
        archived:
          type: boolean
          description: Archived environments cannot be edited or launched until restored.
        archivedAt:
          type: number
          description: Unix epoch milliseconds. Present only when archived.
        createdAt:
          type: number
          description: Unix epoch milliseconds.
        updatedAt:
          type: number
          description: Unix epoch milliseconds.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: >-
            Stable, machine-readable error code. New codes may be added over
            time; treat unknown codes as non-retryable failures unless the HTTP
            status says otherwise.
          enum:
            - UNAUTHORIZED
            - FORBIDDEN
            - NOT_FOUND
            - CONFLICT
            - VALIDATION_ERROR
            - RATE_LIMITED
            - FEATURE_NOT_SUPPORTED
            - SERVER_UNREACHABLE
            - TIMEOUT
            - OAUTH_REQUIRED
            - INTERNAL_ERROR
        message:
          type: string
          description: >-
            Human-readable description. May change between releases — don't
            match on it.
        details:
          type: object
          description: Optional, unstructured context bag.
          additionalProperties: true
    EnvironmentSkillSelection:
      type: object
      description: >-
        An explicit pinned skill selection. Cannot be empty — clear the field
        instead (send `null` on update) to mean "no pinned skills".
      required:
        - mode
        - skillIds
      properties:
        mode:
          type: string
          enum:
            - explicit
        skillIds:
          type: array
          minItems: 1
          items:
            type: string
          description: >-
            Project-shared skill IDs. Skills carrying supporting files or extra
            frontmatter, and plugin-component skills, cannot be pinned.
  responses:
    Unauthorized:
      description: >-
        Missing, invalid, revoked, or orphaned key (`UNAUTHORIZED`) — or the
        **target MCP server** needs an OAuth grant (`OAUTH_REQUIRED`), which is
        a property of the server, not your key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            badKey:
              summary: Invalid or revoked key
              value:
                code: UNAUTHORIZED
                message: Invalid API key
            oauthRequired:
              summary: Target server needs an OAuth grant
              value:
                code: OAUTH_REQUIRED
                message: Server requires OAuth authorization
    Forbidden:
      description: Key is valid but not allowed to do this.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: FORBIDDEN
            message: You do not have access to this project
    NotFound:
      description: Unknown project, server, or resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: NOT_FOUND
            message: Server not found
    RateLimited:
      description: >-
        Per-key rate limit exceeded (60 requests/minute sustained, bursts up to
        10). Honor `Retry-After` and back off with jitter.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: RATE_LIMITED
            message: API key rate limit exceeded. Slow down and retry.
    InternalError:
      description: Something failed on MCPJam's side.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: INTERNAL_ERROR
            message: Unexpected internal error
    ServerUnreachable:
      description: Could not connect to the target MCP server.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: SERVER_UNREACHABLE
            message: Failed to connect to server
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        MCPJam API key (`sk_…`). Create one at [Settings → API
        keys](https://app.mcpjam.com/settings/api-keys). Guest sessions cannot
        use the API, and API keys cannot manage other API keys.

````