Search + K

Command Palette

Search for a command to run...

Sign In

Cancel a workflow run

POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel
Copy endpoint
https://api.github.com

Cancels a workflow run using its id.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Parameters

path Path Parameters

Name Type
owner required

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

string
repo required

The name of the repository without the .git extension. The name is not case sensitive.

string
run_id required

The unique identifier of the workflow run.

number

Responses

202 application/json

Response

interface EmptyObject {}

Client Errors

409 application/json

Conflict

interface BasicError {
message?: string;
documentation_url?: string;
url?: string;
status?: string;
}