Skip to main content
POST
Run a scenario

Authorizations

Authorization
string
header
required

An API key minted in Command Center (Settings -> API Keys), sent as Authorization: Bearer 2501_ak_.... A Command Center session cookie is also accepted.

Path Parameters

id
string
required

Body

application/json
phases
enum<string>[]
Minimum array length: 1
Available options:
prepare,
restore
host
string
Minimum string length: 1
with_agent
boolean
default:false
gateway
enum<string>
default:runner
Available options:
runner,
servicenow
main_engine
string
Minimum string length: 1
secondary_engine
string
Minimum string length: 1
gateway_engine
string
Minimum string length: 1

Response

The launched run

run_id
string
required

What to poll and stop: the report id of a graded run, the workflow id of a phase run

workflow_id
string
required
Example:

"wfl_7d3b9c2e-..."

phases
enum<string>[]
required
Available options:
prepare,
restore
with_agent
boolean
required
host
string
benchmark_id
string
Example:

"bch_0f4a6d1b-..."

report_id
string
Example:

"scr_ca850e32-..."

report_ids
string[]