Cancel a workflow run

POST

/repos/{owner}/{repo}/actions/runs/{run_id}/cancel

Cancels a workflow run using its id. 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 POST 'https://api.github.com/repos///actions/runs//cancel'

Response Example

202 - default

null

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.

run_id

integer

required

The unique identifier of the workflow run.

Responses

🟢202Response

application/json

Body

object {0}

🟠409409

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

Download workflow run attempt logs

List jobs for a workflow run