Delete an environment variable

Deletes an environment variable using the variable name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environment:write` repository permission to use this endpoint.

Script github Verified

by hugo697 ยท 10/25/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 366 days ago
1
type Github = {
2
  token: string;
3
};
4
/**
5
 * Delete an environment variable
6
 * Deletes an environment variable using the variable name.
7
You must authenticate using an access token with the `repo` scope to use this endpoint.
8
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
9
 */
10
export async function main(
11
  auth: Github,
12
  repository_id: string,
13
  name: string,
14
  environment_name: string
15
) {
16
  const url = new URL(
17
    `https://api.github.com/repositories/${repository_id}/environments/${environment_name}/variables/${name}`
18
  );
19

20
  const response = await fetch(url, {
21
    method: "DELETE",
22
    headers: {
23
      Authorization: "Bearer " + auth.token,
24
    },
25
    body: undefined,
26
  });
27
  if (!response.ok) {
28
    const text = await response.text();
29
    throw new Error(`${response.status} ${text}`);
30
  }
31
  return await response.text();
32
}
33