Skip to content
Docs

Create one or more shared environment variables

POST/__remote/api.vercel.com/v1/env
Creates shared environment variable(s) for a team.
Request
import { Edgenivo } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.environment.createSharedEnvVariable({
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      evs: [],
      type: "encrypted",
      target: [
        "production",
        "preview",
      ],
    },
  });


  console.log(result);
}


run();
Response
{
  "created": [
    {
      "applyToAllCustomEnvironments": "false",
      "comment": "string",
      "created": "2021-02-10T13:11:49.180Z",
      "createdAt": "1609492210000",
      "createdBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "customEnvironmentIds": [],
      "decrypted": "false",
      "deletedAt": "1609492210000",
      "deletedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "id": "env_XCG7t7AIHuO2SBA8667zNUiM",
      "key": "my-api-key",
      "lastEditedByDisplayName": "Example Name",
      "lastEditedByPrincipal": {
        "avatar": "string",
        "id": "icfg_1234567890",
        "name": "Example Name",
        "type": "user",
        "username": "string"
      },
      "ownerId": "team_LLHUOMOoDlqOp8wPE4kFo9pE",
      "projectId": [],
      "target": [],
      "type": "encrypted",
      "updatedAt": "1609492210000",
      "updatedBy": "2qDDuGFTWXBLDNnqZfWPDp1A",
      "value": "string"
    }
  ],
  "failed": [
    {
      "error": {
        "action": "string",
        "code": "string",
        "envVarId": "example_id",
        "envVarKey": "string",
        "gitBranch": "string",
        "key": "string",
        "link": "string",
        "message": "string",
        "project": "string",
        "target": [],
        "value": "string"
      }
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

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

Body

application/json
evsarrayRequired
typestringOptional
The type of environment variable
targetarrayRequired
The target environment of the Shared Environment Variable
projectIdarrayOptionalDeprecated
Associate a Shared Environment Variable to projects.

Response

201Success
createdarrayRequired
failedarrayRequired

Errors

400One of the provided values in the request body is invalid.
401The request is not authorized.
402The account is missing a payment so payment method must be updated
403You do not have permission to access this resource.
404Error
410Error