Disable a workflow

PUT

/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///actions/workflows//disable'

Response Example

{}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

workflow_id

string

required

The ID of the workflow. You can also pass the workflow file name as a string.

Responses

🟢204Response

application/json

Body

object {0}

Modified at 2023-08-15 02:59:28

Get a workflow

Create a workflow dispatch event