--- title: edit-an-environment-variable product: vercel url: /docs/rest-api/projects/edit-an-environment-variable type: reference prerequisites: [] related: - /docs/rest-api summary: Learn about edit-an-environment-variable on Vercel. install_vercel_plugin: npx plugins add vercel/vercel-plugin --- # Edit an environment variable ```http PATCH /v9/projects/{idOrName}/env/{id} ``` Edit a specific environment variable for a given project by passing the environment variable identifier and either passing the project `id` or `name` in the URL. ## Authentication **bearerToken**: HTTP bearer ## Path parameters | Name | Type | Required | Description | |---|---|---|---| | `idOrName` | string | Yes | The unique project identifier or the project name | | `id` | string | Yes | The unique environment variable identifier | ## Query parameters | Name | Type | Required | Description | |---|---|---|---| | `teamId` | string | No | The Team identifier to perform the request on behalf of. | | `slug` | string | No | The Team slug to perform the request on behalf of. | ## Request body Required: Yes Content-Type: `application/json` ```json { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the environment variable" }, "target": { "type": "array", "description": "The target environment of the environment variable", "items": { "enum": [ "production", "preview", "development" ] } }, "gitBranch": { "type": "string", "description": "If defined, the git branch of the environment variable (must have target=preview)", "maxLength": 250, "nullable": true }, "type": { "type": "string", "description": "The type of environment variable", "enum": [ "system", "encrypted", "plain", "sensitive" ] }, "value": { "type": "string", "description": "The value of the environment variable" }, "customEnvironmentIds": { "type": "array", "description": "The custom environments that the environment variable should be synced to", "items": { "type": "string" } }, "comment": { "type": "string", "description": "A comment to add context on what this env var is for", "maxLength": 500 } } } ``` ## Responses ### 200: The environment variable was successfully edited Content-Type: `application/json` ```json { "type": "object", "nullable": true, "required": [ "key", "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "secret", "system", "encrypted", "plain", "sensitive" ] }, "value": { "type": "string" }, "edgeConfigId": { "type": "string", "nullable": true }, "edgeConfigTokenId": { "type": "string", "nullable": true }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "id": { "type": "string" }, "createdBy": { "type": "string", "nullable": true }, "target": { "oneOf": [ { "type": "array", "items": { "type": "string", "enum": [ "production", "preview", "development", "preview", "development" ] } }, { "type": "string", "enum": [ "production", "preview", "development", "preview", "development" ] } ] }, "key": { "type": "string" }, "gitBranch": { "type": "string" }, "updatedBy": { "type": "string", "nullable": true }, "sunsetSecretId": { "type": "string", "description": "This is used to identify variables that have been migrated from type secret to sensitive." }, "legacyValue": { "type": "string", "description": "Legacy now-encryption ciphertext, present after migration swaps value/vsmValue" }, "decrypted": { "type": "boolean", "enum": [ false, true ] }, "configurationId": { "type": "string", "nullable": true }, "contentHint": { "nullable": true, "oneOf": [ { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "redis-url" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "redis-rest-api-url" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "redis-rest-api-token" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "redis-rest-api-read-only-token" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "blob-read-write-token" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-url" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-url-non-pooling" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-prisma-url" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-user" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-host" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-password" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-database" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "postgres-url-no-ssl" ] }, "storeId": { "type": "string" } } }, { "type": "object", "required": [ "integrationConfigurationId", "integrationId", "integrationProductId", "storeId", "type" ], "properties": { "type": { "type": "string", "enum": [ "integration-store-secret" ] }, "storeId": { "type": "string" }, "integrationId": { "type": "string" }, "integrationProductId": { "type": "string" }, "integrationConfigurationId": { "type": "string" } } }, { "type": "object", "required": [ "projectId", "type" ], "properties": { "type": { "type": "string", "enum": [ "flags-connection-string" ] }, "projectId": { "type": "string" } } } ] }, "internalContentHint": { "type": "object", "description": "Similar to `contentHints`, but should not be exposed to the user.", "nullable": true, "required": [ "encryptedValue", "type" ], "properties": { "type": { "type": "string", "enum": [ "flags-secret" ] }, "encryptedValue": { "type": "string", "description": "Contains the `value` of the env variable, encrypted with a special key to make decryption possible in the subscriber Lambda." } } }, "comment": { "type": "string" }, "customEnvironmentIds": { "type": "array", "items": { "type": "string" } } } } ``` ### 400: One of the provided values in the request body is invalid. One of the provided values in the request query is invalid. At least one environment variable failed validation ### 401: The request is not authorized. ### 403: You do not have permission to access this resource. ### 404: No description ### 409: The project is being transfered and removing an environment variable is not possible ### 429: No description ### 500: No description --- ## Related - [projects endpoints](/docs/rest-api#projects) - [REST API overview](/docs/rest-api) - [OpenAPI spec](https://openapi.vercel.sh/) (machine-readable, all endpoints) --- [View full sitemap](/docs/sitemap)