provider actions PUT
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable @utdk/github
/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable 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`.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
- owner path required
- The account owner of the repository. The name is not case sensitive.
- string
- repo path required
- The name of the repository without the `.git` extension. The name is not case sensitive.
- string
- workflow_id path required
- The ID of the workflow. You can also pass the workflow file name as a string.
Try it
Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import github from '@utdk/github';
await github.actions.disableWorkflow()