Skip to main content
Request batch cancellation

Authorizations

Authorization
string
header
required

Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.

Headers

Idempotency-Key
string
required

Save a unique stable key for this exact logical action, at most 200 characters. Reuse it with identical input after an uncertain response. A new key is new intent; it must not be used merely to recover an accepted action.

Required string length: 1 - 200

Path Parameters

batchId
string
required
Required string length: 1 - 160

Body

application/json
projectId
string
required
Required string length: 1 - 160
environmentId
string
required
Required string length: 1 - 160

Response

The retained resource or operation response.

id
string
required
projectId
string
required
environmentId
string
required
name
string
required
recipe
object
required
createdAt
string
required
cancellationRequested
boolean
required
total
number
required
counts
object
required
charge
object
required
targetExecution
object
operations
object
submission
null | object