Skip to main content
Read a simulation batch

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

x-fd-read-scope-version
string

Send all three selected-read headers together. The response echoes the confirmed selection.

Allowed value: "2026-10-16-read-scope.1"
x-fd-read-project-id
string

Your selected project. A resource outside the selected context returns 409.

x-fd-read-environment-id
string

Your selected environment. These headers never grant authority.

Path Parameters

batchId
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