Mutation
mutation CancelGitHubActionsWorkflowRun($codebaseRepositoryId: ID!, $workflowRunId: ID!, $source: GitHubRequestSource!) {
cancelGitHubActionsWorkflowRun(codebaseRepositoryId: $codebaseRepositoryId, workflowRunId: $workflowRunId, source: $source)
}Variables
{
"codebaseRepositoryId": "id",
"workflowRunId": "id",
"source": "GITHUB_API"
}Response
{
"data": {
"cancelGitHubActionsWorkflowRun": true
}
}Mutations
cancelGitHubActionsWorkflowRun
Cancels a GitHub actions workflow run and reports whether the operation succeeded.
MUTATION
cancelGitHubActionsWorkflowRun(codebaseRepositoryId: ID!, workflowRunId: ID!, force: Boolean!, source: GitHubRequestSource!): Boolean!Arguments
codebaseRepositoryId
ID!
required
Identifier of the codebase repository.
workflowRunId
ID!
required
Identifier of the workflow run.
force
Boolean!
default:false
Whether force applies to the operation. Defaults to false.
source
required
The source used to filter or perform the operation.
Returns
Boolean!
Mutation
mutation CancelGitHubActionsWorkflowRun($codebaseRepositoryId: ID!, $workflowRunId: ID!, $source: GitHubRequestSource!) {
cancelGitHubActionsWorkflowRun(codebaseRepositoryId: $codebaseRepositoryId, workflowRunId: $workflowRunId, source: $source)
}Variables
{
"codebaseRepositoryId": "id",
"workflowRunId": "id",
"source": "GITHUB_API"
}Response
{
"data": {
"cancelGitHubActionsWorkflowRun": true
}
}