0

Retrieve custom environments

by
Published Apr 8, 2025

Retrieve custom environments 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
 * Retrieve custom environments
7
 * Retrieve custom environments for the project. Must not be named 'Production' or 'Preview'.
8
 */
9
export async function main(
10
  auth: Vercel,
11
  idOrName: string,
12
  gitBranch: string | undefined,
13
  teamId: string | undefined,
14
  slug: string | undefined,
15
) {
16
  const url = new URL(
17
    `https://api.vercel.com/v9/projects/${idOrName}/custom-environments`,
18
  );
19
  for (const [k, v] of [
20
    ["gitBranch", gitBranch],
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: "GET",
30
    headers: {
31
      Authorization: "Bearer " + auth.token,
32
    },
33
    body: undefined,
34
  });
35
  if (!response.ok) {
36
    const text = await response.text();
37
    throw new Error(`${response.status} ${text}`);
38
  }
39
  return await response.json();
40
}
41