Skip to content
Docs

Retrieve the decrypted value of an environment variable of a project by id

GET/__remote/api.vercel.com/v1/projects/{idOrName}/env/{id}
Retrieve the environment variable for a given project.
Request
import { Edgenivo } from "@vercel/sdk";


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


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


  console.log(result);
}


run();
Response
{
  "comment": "string",
  "configurationId": "example_id",
  "contentHint": {
    "storeId": "example_id",
    "type": "redis-url"
  },
  "createdAt": "123",
  "createdBy": "string",
  "customEnvironmentIds": [],
  "decrypted": "false",
  "edgeConfigId": "example_id",
  "edgeConfigTokenId": "example_id",
  "gitBranch": "string",
  "id": "icfg_1234567890",
  "key": "string",
  "sunsetSecretId": "example_id",
  "target": [],
  "type": "encrypted",
  "updatedAt": "123",
  "updatedBy": "string",
  "visibility": "config"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrNamestringRequired
The unique project identifier or the project name
idstringRequired
The unique ID for the environment variable to get the decrypted value.

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
commentstringOptional
configurationIdstringOptional
contentHintobjectOptional17 variants
createdAtnumberOptional
createdBystringOptional
customEnvironmentIdsarrayOptional
decryptedbooleanRequired
edgeConfigIdstringOptional
edgeConfigTokenIdstringOptional
gitBranchstringOptional
idstringOptional
keystringRequired
sunsetSecretIdstringOptional
This is used to identify variables that have been migrated from type secret to sensitive.
targetobjectOptional2 variants
typestringRequired
updatedAtnumberOptional
updatedBystringOptional
visibilitystringOptional
User-facing config/secret model. When set, authoritative for new code paths. Legacy rows omit this field and callers fall back to existing type behavior.

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error