projects

Create one or more environment variables

Changed on

Create one or more environment variables for a project by passing its key, value, type and target and by specifying the project by either passing the project id or name in the URL. If you include upsert=true as a query parameter, a new environment variable will not be created if it already exists but, the existing variable's value will be updated.

post/v10/projects/{idOrName}/env

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v10/projects/{idOrName}/env
  • Auth: HTTP bearer

Path parameters

idOrNamestring required

The unique project identifier or the project name

Example:prj_XLKmu1DyR1eY7zq8UgeRKbA7yVLA

Query parameters

upsertstring

Allow override of environment variable if it already exists

Example:true
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

OR

Example request

[
  {
    "key": "API_URL",
    "value": "https://api.vercel.com",
    "type": "plain",
    "target": [
      "preview"
    ],
    "gitBranch": "feature-1",
    "comment": "database connection string for production",
    "customEnvironmentIds": [
      "env_1234567890"
    ]
  }
]

Response

The environment variable was created successfully

Changes

  • bc022fa59ffbRevision changes
    • breaking

      added subschema #1 subschema #2 to the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

  • b7b824605094Revision changes
    • breaking

      the response property became optional for the status