Updates one or more shared environment variables

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>"
      }
    }
  ]
}

PATCH

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

Show child attributes

updates.{key}

object

Show child attributes

updates.{key}.key

string

The name of the Shared Environment Variable

Example:

"API_URL"

updates.{key}.value

string

The value of the Shared Environment Variable

Example:

"https://api.vercel.com"

updates.{key}.target

enum<string>[]

The target environment of the Shared Environment Variable

Available options:

production,

preview,

development

Example:

["production", "preview"]

updates.{key}.projectId

string[]

Associate a Shared Environment Variable to projects.

Example:

[
  "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
  "prj_2WjyKQmM8ZnGcJsPWMrHRCRV"
]

updates.{key}.projectIdUpdates

object

Incrementally update project linking without specifying the full list

Show child attributes

updates.{key}.projectIdUpdates.link

string[]

Project IDs to add to this environment variable

Example:

["prj_2WjyKQmM8ZnGcJsPWMrHRHrE"]

updates.{key}.projectIdUpdates.unlink

string[]

Project IDs to remove from this environment variable

Example:

["prj_2WjyKQmM8ZnGcJsPWMrHRCRV"]

updates.{key}.type

enum<string>

The new type of the Shared Environment Variable

Available options:

encrypted,

sensitive

Example:

"encrypted"

updates.{key}.comment

string

A comment to add context on what this Shared Environment Variable is for

Maximum string length: 500

Example:

"database connection string for production"

Example:

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

Response

updated

object[]

required

Show child attributes

updated.created

string<date-time>

The date when the Shared Env Var was created.

Example:

"2021-02-10T13:11:49.180Z"

updated.key

string

The name of the Shared Env Var.

Example:

"my-api-key"

updated.ownerId

string | null

The unique identifier of the owner (team) the Shared Env Var was created for.

Example:

"team_LLHUOMOoDlqOp8wPE4kFo9pE"

updated.id

string

The unique identifier of the Shared Env Var.

Example:

"env_XCG7t7AIHuO2SBA8667zNUiM"

updated.createdBy

string | null

The unique identifier of the user who created the Shared Env Var.

Example:

"2qDDuGFTWXBLDNnqZfWPDp1A"

updated.deletedBy

string | null

The unique identifier of the user who deleted the Shared Env Var.

Example:

"2qDDuGFTWXBLDNnqZfWPDp1A"

updated.updatedBy

string | null

The unique identifier of the user who last updated the Shared Env Var.

Example:

"2qDDuGFTWXBLDNnqZfWPDp1A"

updated.createdAt

number

Timestamp for when the Shared Env Var was created.

Example:

1609492210000

updated.deletedAt

number

Timestamp for when the Shared Env Var was (soft) deleted.

Example:

1609492210000

updated.updatedAt

number

Timestamp for when the Shared Env Var was last updated.

Example:

1609492210000

updated.value

string

The value of the Shared Env Var.

updated.projectId

string[]

The unique identifiers of the projects which the Shared Env Var is linked to.

Example:

[
  "prj_2WjyKQmM8ZnGcJsPWMrHRHrE",
  "prj_2WjyKQmM8ZnGcJsPWMrasEFg"
]

updated.type

enum<string>

The type of this cosmos doc instance, if blank, assume secret.

Available options:

encrypted,

sensitive,

system,

plain

Example:

"encrypted"

updated.target

enum<string>[]

environments this env variable targets

Available options:

production,

preview,

development

Example:

"production"

updated.applyToAllCustomEnvironments

boolean

whether or not this env varible applies to custom environments

updated.decrypted

boolean

whether or not this env variable is decrypted

updated.comment

string

A user provided comment that describes what this Shared Env Var is for.

updated.lastEditedByDisplayName

string

The last editor full name or username.

failed

object[]

required

Show child attributes

failed.error

object

required

Show child attributes

failed.error.code

string

required

failed.error.message

string

required

failed.error.key

string

failed.error.envVarId

string

failed.error.envVarKey

string

failed.error.action

string

failed.error.link

string

failed.error.value

failed.error.gitBranch

string

failed.error.target

Available options:

production,

preview,

development,

preview,

development

failed.error.project

string

Delete one or more Env Var Retrieve the decrypted value of a Shared Environment Variable by id.

⌘I

Endpoints

Authorizations

Query Parameters

Body

Response