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.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The unique environment variable identifier |
idOrName |
String | Yes |
The unique project identifier or the project name |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
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 fields
| Name | Type | Required | Description |
|---|---|---|---|
customEnvironmentIds[] |
Array | No |
The custom environments that the environment variable should be synced to |
comment |
String | No |
A comment to add context on what this env var is for |
gitBranch |
String | No |
If defined, the git branch of the environment variable (must have target=preview) |
key |
String | No |
The name of the environment variable |
target[] |
Array | No |
The target environment of the environment variable |
type |
String | No |
The type of environment variable Possible values:
|
value |
String | No |
The value of the environment variable |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.