Cancel a workflow run

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.

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

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

owner string required
repo string required
run_id integer required: The id of the workflow run.

Responses

application/json object

Response

Response body object

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

owner *

repo *

run_id *

The id of the workflow run.

Request Sample: Shell / cURL

curl --request POST \
  --url {protocol}://{hostname}/api/v3/repos/{owner}/{repo}/actions/runs/{run_id}/cancel