POST
/
v9
/
projects
/
{idOrName}
/
custom-environments
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.environment.createCustomEnvironment({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  // Handle the result
  console.log(result);
}

run();
{}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The unique project identifier or the project name

Query Parameters

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

Body

application/json
​
slug
string

The slug of the custom environment to create.

Maximum length: 32
​
description
string

Description of the custom environment. This is optional.

Maximum length: 256
​
branchMatcher
object

How we want to determine a matching branch. This is optional.

​
copyEnvVarsFrom
string

Where to copy environment variables from. This is optional.

Response

201
application/json

The response is of type object.