0

Delete a Deployment

by
Published Apr 8, 2025

This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.

Script vercel Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Vercel = {
3
  token: string;
4
};
5
/**
6
 * Delete a Deployment
7
 * This API allows you to delete a deployment, either by supplying its `id` in the URL or the `url` of the deployment as a query parameter. You can obtain the ID, for example, by listing all deployments.
8
 */
9
export async function main(
10
  auth: Vercel,
11
  id: string,
12
  url: string | undefined,
13
  teamId: string | undefined,
14
  slug: string | undefined,
15
) {
16
  const url_ = new URL(`https://api.vercel.com/v13/deployments/${id}`);
17
  for (const [k, v] of [
18
    ["url", url],
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: "DELETE",
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