Skip to main content
DELETE
/
v9
/
projects
/
{idOrName}
/
env
/
{id}
removeProjectEnv
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.removeProjectEnv({
    idOrName: "prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA",
    id: "XMbOEya1gUUO1ir4",
    customEnvironmentId: "env_123abc4567",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
[
  {
    "type": "secret",
    "value": "<string>",
    "key": "<string>",
    "edgeConfigId": "<string>",
    "edgeConfigTokenId": "<string>",
    "createdAt": 123,
    "updatedAt": 123,
    "id": "<string>",
    "createdBy": "<string>",
    "target": [
      "production"
    ],
    "gitBranch": "<string>",
    "updatedBy": "<string>",
    "sunsetSecretId": "<string>",
    "legacyValue": "<string>",
    "decrypted": false,
    "configurationId": "<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

​
customEnvironmentId
string

The unique custom environment identifier within the project

Example:

"env_123abc4567"

​
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"

Response

The environment variable was successfully removed

​
type
enum<string>
required
Available options:
secret,
system,
encrypted,
plain,
sensitive
​
value
string
required
​
key
string
required
​
edgeConfigId
string | null
​
edgeConfigTokenId
string | null
​
createdAt
number
​
updatedAt
number
​
id
string
​
createdBy
string | null
​
target
Available options:
production,
preview,
development,
preview,
development
​
gitBranch
string
​
updatedBy
string | null
​
sunsetSecretId
string

This is used to identify variables that have been migrated from type secret to sensitive.

​
legacyValue
string

Legacy now-encryption ciphertext, present after migration swaps value/vsmValue

​
decrypted
enum<boolean>
Available options:
true,
false
​
configurationId
string | null
​
contentHint
object
​
internalContentHint
object

Similar to contentHints, but should not be exposed to the user.

​
comment
string
​
customEnvironmentIds
string[]