Skip to main content
Preview a simulation recipe

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.

Body

application/json
projectId
string
required
Required string length: 1 - 160
environmentId
string
required
Required string length: 1 - 160
schemaVersion
string
required
Allowed value: "2026-10-14-preparation.1"
recipe
object
required

Response

The retained resource or operation response.

schemaVersion
string
required
Allowed value: "2026-10-14-preparation.1"
projectId
string
required
environmentId
string
required
checkedAt
string
required
recipeDigest
string
required
scenarios
object[]
required
expansion
object
required
target
object
required
services
object
required
limits
object
required
estimates
object
required
admission
object
required
assessment
object
required
charge
object
required
limitations
string[]
required
retention
object
populationDisclosure
object
targetExecution
object