Skip to main content
PATCH
/
v1
/
env
updateSharedEnvVariable
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.environment.updateSharedEnvVariable({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      updates: {
        "env_2WjyKQmM8ZnGcJsPWMrHRHrE": {
          key: "API_URL",
          value: "https://api.vercel.com",
          target: [
            "production",
            "preview",
          ],
          projectIdUpdates: {
            link: [
              "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
            ],
          },
        },
      },
    },
  });

  console.log(result);
}

run();
{
  "updated": [
    {
      "created": "2021-02-10T13:11:49.180Z",
      "key": "my-api-key",
      "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
      "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
      "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "createdAt": 1609492210000,
      "deletedAt": 1609492210000,
      "updatedAt": 1609492210000,
      "value": "<string>",
      "projectId": [
        "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
        "prj_2WjyKQmM8ZnGcJsPWMrasEFg"
      ],
      "type": "encrypted",
      "target": "production",
      "applyToAllCustomEnvironments": true,
      "decrypted": true,
      "comment": "<string>",
      "lastEditedByDisplayName": "<string>"
    }
  ],
  "failed": [
    {
      "error": {
        "code": "<string>",
        "message": "<string>",
        "key": "<string>",
        "envVarId": "<string>",
        "envVarKey": "<string>",
        "action": "<string>",
        "link": "<string>",
        "value": "<string>",
        "gitBranch": "<string>",
        "target": [
          "production"
        ],
        "project": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

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
​
updates
object
required

An object where each key is an environment variable ID (not the key name) and the value is the update to apply

Example:
{
  "env_2WjyKQmM8ZnGcJsPWMrHRHrE": {
    "key": "API_URL",
    "value": "https://api.vercel.com",
    "target": ["production", "preview"],
    "projectIdUpdates": { "link": ["prj_2WjyKQmM8ZnGcJsPWMrHRHrE"] }
  }
}

Response

​
updated
object[]
required
​
failed
object[]
required