0

Remove a custom environment

by
Published Apr 8, 2025

Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.

Script vercel Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Vercel = {
3
  token: string;
4
};
5
/**
6
 * Remove a custom environment
7
 * Remove a custom environment for the project. Must not be named 'Production' or 'Preview'.
8
 */
9
export async function main(
10
  auth: Vercel,
11
  idOrName: string,
12
  environmentSlugOrId: string,
13
  teamId: string | undefined,
14
  slug: string | undefined,
15
  body: { deleteUnassignedEnvironmentVariables?: false | true },
16
) {
17
  const url = new URL(
18
    `https://api.vercel.com/v9/projects/${idOrName}/custom-environments/${environmentSlugOrId}`,
19
  );
20
  for (const [k, v] of [
21
    ["teamId", teamId],
22
    ["slug", slug],
23
  ]) {
24
    if (v !== undefined && v !== "" && k !== undefined) {
25
      url.searchParams.append(k, v);
26
    }
27
  }
28
  const response = await fetch(url, {
29
    method: "DELETE",
30
    headers: {
31
      "Content-Type": "application/json",
32
      Authorization: "Bearer " + auth.token,
33
    },
34
    body: JSON.stringify(body),
35
  });
36
  if (!response.ok) {
37
    const text = await response.text();
38
    throw new Error(`${response.status} ${text}`);
39
  }
40
  return await response.json();
41
}
42