EditProjectEnvRequestBody

March 8, 2025 ยท View on GitHub

Example Usage

import { EditProjectEnvRequestBody } from "@vercel/sdk/models/editprojectenvop.js";

let value: EditProjectEnvRequestBody = {
  key: "GITHUB_APP_ID",
  target: [
    "preview",
  ],
  gitBranch: "feature-1",
  type: "plain",
  value: "bkWIjbnxcvo78",
  customEnvironmentIds: [
    "env_1234567890",
  ],
  comment: "database connection string for production",
};

Fields

FieldTypeRequiredDescriptionExample
keystring:heavy_minus_sign:The name of the environment variableGITHUB_APP_ID
targetmodels.EditProjectEnvTarget[]:heavy_minus_sign:The target environment of the environment variable[
"preview"
]
gitBranchstring:heavy_minus_sign:If defined, the git branch of the environment variable (must have target=preview)feature-1
typemodels.EditProjectEnvType:heavy_minus_sign:The type of environment variableplain
valuestring:heavy_minus_sign:The value of the environment variablebkWIjbnxcvo78
customEnvironmentIdsstring[]:heavy_minus_sign:The custom environments that the environment variable should be synced to
commentstring:heavy_minus_sign:A comment to add context on what this env var is fordatabase connection string for production