logo Windmill Hub
Login
All items

Disable a workflow

Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.

Script github Verified

by hugo697 ยท 10/25/2023

Use in Windmill

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 366 days ago
All edits
Permalink
1 
type Github = {
2 
  token: string;
3 
};
4 
/**
5 
 * Disable a workflow
6 
 * Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.
7
8 
You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.
9 
 */
10 
export async function main(
11 
  auth: Github,
12 
  owner: string,
13 
  repo: string,
14 
  workflow_id: string
15 
) {
16 
  const url = new URL(
17 
    `https://api.github.com/repos/${owner}/${repo}/actions/workflows/${workflow_id}/disable`
18 
  );
19
20 
  const response = await fetch(url, {
21 
    method: "PUT",
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