Skip to main content
POST
/
v1
/
projects
/
{project}
/
rollouts
/
{rollout}
/
stages
/
{stage}
/
tasks
/
{task}
/
taskRuns:batchCancel
cURL
curl --request POST \
  --url https://api.example.com/v1/projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns:batchCancel \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent": "<string>",
  "taskRuns": [
    "<string>"
  ],
  "reason": "<string>"
}
'
{}

Path Parameters

​
project
string
required

The project id.

​
rollout
string
required

The rollout id.

​
stage
string
required

The stage id.

​
task
string
required

The task id.

Body

application/json
​
parent
string

The name of the parent of the taskRuns. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task} Use projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/- to cancel task runs under the same stage.

​
taskRuns
string[]

The taskRuns to cancel. Format: projects/{project}/rollouts/{rollout}/stages/{stage}/tasks/{task}/taskRuns/{taskRun}

​
reason
string

The reason for canceling the task runs.

Response

OK

The response is of type object.