0

Get a deployment by ID or URL

by
Published Apr 8, 2025

Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment.

Script vercel Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Vercel = {
3
  token: string;
4
};
5
/**
6
 * Get a deployment by ID or URL
7
 * Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment.
8
 */
9
export async function main(
10
  auth: Vercel,
11
  idOrUrl: string,
12
  withGitRepoInfo: string | undefined,
13
  teamId: string | undefined,
14
  slug: string | undefined,
15
) {
16
  const url = new URL(`https://api.vercel.com/v13/deployments/${idOrUrl}`);
17
  for (const [k, v] of [
18
    ["withGitRepoInfo", withGitRepoInfo],
19
    ["teamId", teamId],
20
    ["slug", slug],
21
  ]) {
22
    if (v !== undefined && v !== "" && k !== undefined) {
23
      url.searchParams.append(k, v);
24
    }
25
  }
26
  const response = await fetch(url, {
27
    method: "GET",
28
    headers: {
29
      Authorization: "Bearer " + auth.token,
30
    },
31
    body: undefined,
32
  });
33
  if (!response.ok) {
34
    const text = await response.text();
35
    throw new Error(`${response.status} ${text}`);
36
  }
37
  return await response.json();
38
}
39