PATCH
/
v9
/
projects
/
{idOrName}
/
env
/
{id}
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.projects.editProjectEnv({
    idOrName: "prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA",
    id: "XMbOEya1gUUO1ir4",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      key: "GITHUB_APP_ID",
      target: [
        "preview",
      ],
      gitBranch: "feature-1",
      type: "plain",
      value: "bkWIjbnxcvo78",
      customEnvironmentIds: [
        "env_1234567890",
      ],
      comment: "database connection string for production",
    },
  });

  console.log(result);
}

run();
{
  "target": [
    "<string>"
  ],
  "type": "system",
  "sunsetSecretId": "<string>",
  "decrypted": true,
  "value": "<string>",
  "id": "<string>",
  "key": "<string>",
  "configurationId": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "gitBranch": "<string>",
  "edgeConfigId": "<string>",
  "edgeConfigTokenId": "<string>",
  "contentHint": {
    "type": "redis-url",
    "storeId": "<string>"
  },
  "internalContentHint": {
    "type": "flags-secret",
    "encryptedValue": "<string>"
  },
  "comment": "<string>",
  "customEnvironmentIds": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The unique project identifier or the project name

Example:

"prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA"

​
id
string
required

The unique environment variable identifier

Example:

"XMbOEya1gUUO1ir4"

Query Parameters

​
teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

​
slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json

Response

200
application/json

The environment variable was successfully edited

The response is of type object.