Skip to main content
POST
Cancel a queued or running batch

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format. The CLI's ta auth access tokens are also accepted; because they name a user rather than a workspace, a user in several workspaces selects one with the x-testerarmy-team header (workspace id or slug).

Path Parameters

batchId
string<uuid>
required

Batch ID

Response

Batch cancellation summary

batchId
string<uuid>
required
cancelled
integer
required
Required range: x >= 0
alreadyFinished
integer
required
Required range: x >= 0
cancelledRunIds
string<uuid>[]
required
alreadyFinishedRunIds
string<uuid>[]
required