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

# Update an environment variable

> Changes an organization-level environment variable's value or secrets manager reference. The change reaches the crews that carry the variable, and they are redeployed with the code they run now when the organization redeploys on variable changes.



## OpenAPI

````yaml /openapi/platform-v1.yaml patch /api/v1/environment-variables/{id}
openapi: 3.0.1
info:
  title: CrewAI Platform API
  version: v1
  description: Supported public API for CrewAI Platform.
servers:
  - url: https://app.crewai.com
    description: Current CrewAI Platform host
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Users in the organization.
  - name: Status
    description: Platform health and API availability.
  - name: Automations
    description: >-
      Automations, their source artifacts, their executions, and their
      schedules.
  - name: Teams
    description: Teams in the organization.
  - name: Group Mappings
    description: Identity-provider group mappings to Teams.
  - name: Service Accounts
    description: Service accounts in the organization.
  - name: Webhook Endpoints
    description: Endpoints that receive signed event deliveries.
  - name: Studio Projects
    description: Projects built in Crew Studio.
  - name: Environment Variables
    description: Environment variables in the organization.
  - name: Git Repositories
    description: Git repositories connected to the organization.
  - name: LLM Connections
    description: Connections to LLM providers.
  - name: Tools
    description: Tools in the organization's tool repository.
  - name: Applications
    description: Applications the organization can connect, with their tools and triggers.
  - name: Connections
    description: Application connections the caller can use.
paths:
  /api/v1/environment-variables/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
    patch:
      tags:
        - Environment Variables
      summary: Update an environment variable
      description: >-
        Changes an organization-level environment variable's value or secrets
        manager reference. The change reaches the crews that carry the variable,
        and they are redeployed with the code they run now when the organization
        redeploys on variable changes.
      operationId: updateEnvironmentVariable
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                value:
                  type: string
                  example: sk-proj-1234
                  description: 'The value. Write-only: it is never returned.'
                secrets_provider:
                  type: string
                  example: aws
                  enum:
                    - aws
                    - azure
                    - gcp
                  description: >-
                    Read the value from this secrets manager at runtime instead
                    of storing it. Requires `secrets_key`.
                secrets_key:
                  type: string
                  example: prod/openai
                  description: The secret's name in the secrets manager.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                success:
                  value:
                    data:
                      id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      key: API_KEY
                      secrets_provider: null
                      secrets_key: null
                      created_at: '2026-07-07T00:00:00Z'
                      updated_at: '2026-07-07T00:00:00Z'
                  summary: Environment variable updated
                redeployed:
                  value:
                    data:
                      id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      key: API_KEY
                      secrets_provider: null
                      secrets_key: null
                      created_at: '2026-07-07T00:00:00Z'
                      updated_at: '2026-07-07T00:00:00Z'
                  summary: Environment variable updated and its crews redeployed
              schema:
                type: object
                required:
                  - data
                additionalProperties: false
                properties:
                  data:
                    type: object
                    required:
                      - id
                      - key
                      - secrets_provider
                      - secrets_key
                      - created_at
                      - updated_at
                    additionalProperties: false
                    properties:
                      id:
                        type: string
                        format: uuid
                        example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                      key:
                        type: string
                        example: OPENAI_API_KEY
                        description: The variable's name.
                      secrets_provider:
                        type: string
                        example: null
                        nullable: true
                        enum:
                          - aws
                          - azure
                          - gcp
                          - null
                        description: >-
                          The secrets manager the value is read from at runtime.
                          Null when the variable holds its own value.
                      secrets_key:
                        type: string
                        example: null
                        nullable: true
                        description: >-
                          The secret's name in the secrets manager. Null when
                          the variable holds its own value.
                      created_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2026-07-07T00:00:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/unauthorized
                        code: unauthorized
                        title: Unauthorized
                        status: 401
                        detail: Missing or invalid bearer token.
                  summary: Missing or invalid bearer token
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not Found
          content:
            application/json:
              examples:
                not_found:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/not_found
                        code: not_found
                        title: Not found
                        status: 404
                        detail: The requested resource could not be found.
                  summary: >-
                    Environment variable is outside the authenticated service
                    account's organization
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              examples:
                invalid_secrets_provider:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/validation_error
                        code: validation_error
                        title: Validation error
                        status: 422
                        detail: Secrets provider is not included in the list
                  summary: Secrets provider is not supported
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - errors
      additionalProperties: false
      properties:
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      description: Public API error object.
      required:
        - type
        - code
        - title
        - status
        - detail
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          enum:
            - https://docs-platform.crewai.com/api/problems/bad_request
            - https://docs-platform.crewai.com/api/problems/clipper_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_disallowed
            - >-
              https://docs-platform.crewai.com/api/problems/clipper_feature_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_not_found
            - https://docs-platform.crewai.com/api/problems/conflict
            - https://docs-platform.crewai.com/api/problems/content_too_large
            - https://docs-platform.crewai.com/api/problems/forbidden
            - https://docs-platform.crewai.com/api/problems/internal_error
            - https://docs-platform.crewai.com/api/problems/not_found
            - https://docs-platform.crewai.com/api/problems/service_unavailable
            - >-
              https://docs-platform.crewai.com/api/problems/tool_execution_failed
            - https://docs-platform.crewai.com/api/problems/unauthorized
            - https://docs-platform.crewai.com/api/problems/validation_error
          example: https://docs-platform.crewai.com/api/problems/bad_request
        code:
          type: string
          enum:
            - bad_request
            - clipper_disabled
            - clipper_disallowed
            - clipper_feature_disabled
            - clipper_not_found
            - conflict
            - content_too_large
            - forbidden
            - internal_error
            - not_found
            - service_unavailable
            - tool_execution_failed
            - unauthorized
            - validation_error
          example: bad_request
        title:
          type: string
          x-crewai-enum-format: freeform
          enum:
            - Bad request
            - Clipper resource disabled
            - Clipper resource disallowed
            - Clipper feature disabled
            - Clipper resource not found
            - Conflict
            - Content too large
            - Forbidden
            - Internal error
            - Not found
            - Service unavailable
            - Tool execution failed
            - Unauthorized
            - Validation error
          example: Bad request
        status:
          type: integer
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 413
            - 422
            - 500
            - 503
          example: 400
        detail:
          type: string
          example: The request is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque

````

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