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

# Update an environment description

> Change the long-form description shown on the environment details page. Use this
to document purpose, base image notes, or usage guidance for collaborators.

Required permissions: `EditEnvironment`

Related:
- GET /api/environments/v1/environments/{environmentId} (read current description)
- PUT /api/environments/v1/environments/{environmentId}/name (rename environment)
- DELETE /api/environments/v1/environments/{environmentId} (archive environment)




## OpenAPI

````yaml /api-specs/cloud/public-api.json put /api/environments/v1/environments/{environmentId}/description
openapi: 3.0.3
info:
  title: Domino Public API
  description: Reference for Domino's public REST API endpoints.
  version: 6.4.0
  x-catalog-key: nucleus
servers:
  - url: https://mycluster.domino.tech
    description: >-
      Replace 'mycluster.domino.tech' with your Domino cluster hostname. For
      Domino Cloud customers, that is `your-subdomain`.domino.tech (e.g.,
      acme.domino.tech). For self-hosted deployments, it is the hostname you
      reach the Domino UI at.
security: []
tags:
  - name: Projects
  - name: Project templates
  - name: Workspaces
  - name: Jobs
  - name: HPC Jobs
  - name: Environments
  - name: Hardware Tiers
  - name: Datasets
  - name: Data Sources
  - name: GenAI
  - name: AI Systems
  - name: Apps
  - name: App versions
  - name: App instances
  - name: Model APIs
  - name: Registered models
  - name: Model deployment
  - name: Extensions
  - name: Cost and billing
  - name: Users and organizations
  - name: Service accounts
  - name: Personal Access Tokens
  - name: Personal Access Tokens (admin)
  - name: Audit Trail
  - name: Custom metrics
  - name: PPM
  - name: Model Monitoring models
  - name: Model Monitoring drift and quality
  - name: Model Monitoring settings
  - name: Model Monitoring authentication
  - name: Governance bundles
  - name: Governance policies
  - name: Governance evidence and results
  - name: Governance operations
  - name: NetApp Volumes
  - name: NetApp Volumes snapshots
  - name: NetApp Volumes filesystems
  - name: NetApp Volumes transfers
  - name: Tags
  - name: Properties
externalDocs:
  description: OpenAPI
  url: https://swagger.io/resources/open-api/
paths:
  /api/environments/v1/environments/{environmentId}/description:
    put:
      tags:
        - Environments
      summary: Update an environment description
      description: >
        Change the long-form description shown on the environment details page.
        Use this

        to document purpose, base image notes, or usage guidance for
        collaborators.


        Required permissions: `EditEnvironment`


        Related:

        - GET /api/environments/v1/environments/{environmentId} (read current
        description)

        - PUT /api/environments/v1/environments/{environmentId}/name (rename
        environment)

        - DELETE /api/environments/v1/environments/{environmentId} (archive
        environment)
      operationId: updateEnvironmentDescription
      parameters:
        - description: >
            Domino environment ID (24-character hex string). Obtain from

            GET /api/environments/beta/environments, GET
            /api/environments/v1/environments/{environmentId},

            or the environment details page URL.
          in: path
          name: environmentId
          required: true
          schema:
            example: 623132867a0af0281c01a69c
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEnvironmentDescriptionV1'
        description: New environment description
        required: true
      responses:
        '200':
          description: Description updated.
        '400':
          description: >
            Invalid request. Common causes:

            - `description` field is missing from the request body.

            - The environment is archived (`Environment is already archived.`).

            Unarchive is not supported via API; create a new environment
            instead.
        '401':
          $ref: '#/components/responses/401'
        '403':
          description: |
            Caller lacks `EditEnvironment` permission for this environment.
        '404':
          description: >
            `environmentId` not found or not visible to the caller. Verify the
            ID from

            GET /api/environments/v1/environments/{environmentId}.
        '500':
          $ref: '#/components/responses/500'
      security:
        - DominoApiKey: []
        - BearerAuthentication: []
components:
  schemas:
    UpdateEnvironmentDescriptionV1:
      properties:
        description:
          description: New description for the environment
          type: string
      required:
        - description
      type: object
    ErrorV1:
      properties:
        code:
          description: Machine-readable error code.
          example: NOT_FOUND
          type: string
        message:
          description: Human-readable description of the error.
          example: The requested HPC Job could not be found.
          type: string
      required:
        - message
      type: object
  responses:
    '401':
      content:
        application/json:
          example:
            code: UNAUTHORIZED
            message: Authentication is required to access this resource.
          schema:
            $ref: '#/components/schemas/ErrorV1'
      description: Unauthorized - authentication is required or has failed.
    '500':
      content:
        application/json:
          schema:
            properties:
              error:
                type: string
            type: object
      description: Internal Server Error
  securitySchemes:
    DominoApiKey:
      type: apiKey
      in: header
      name: X-Domino-Api-Key
    BearerAuthentication:
      type: apiKey
      name: Authorization
      in: header

````

## Related topics

- [Update the restricted revision of an environment](/api-reference/environments/update-the-restricted-revision-of-an-environment.md)
- [Create a Domino Environment](/cloud/platform-capabilities/core-concepts/compute-environments/manage-compute-environments/3-create-an-environment.md)
- [Update a property](/api-reference/properties/update-a-property.md)
- [Update a customer project template](/api-reference/project-templates/update-a-customer-project-template.md)