Welcome to SafeBreach API Documentation

Sections

Return count of expected simulations for a scenario

Header Parameters

Content-Typestring
Acceptstring
x-apitokenstring

Query Parameters

includeDisabledstring

Should include disconnected simulators in calculation. True = Include disconnected simulators in calculation. False = Ignore disconnected simulators in calculation

useCachestring

Indicates if cache should be used ( default is true )

limitstring

Limit number of plan breach methods

getConstraintsstring

should return constraints causing simulators to not run moves

getAllConstraintsstring

Whether to run every validator against the full, unfiltered node set so each simulator can accumulate every applicable constraint reason (true), or run validators as a filtering chain where each simulator records only the first reason that eliminated it (false, default).

Path Parameters

accountIdstring Required

The account ID for which the operation is required

Body Parameters

idstring
accountIdstring
planIdstring
testIdstring
tagsobject
systemTagsarray
namestring
planRunIdstring
capturestring
debugstring
draftstring
forcestring
prioritystring
successCriteriaobject
stepsarray
flowControlobject
retrySimulationsstring
retryPolicystring
originalScenarioIdstring
actionsarray
edgesarray
systemFilterobject
emailRecipientsarray

Response

200
Object

Response Attributes

dataobject
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?