Create a Scenario

This guide is designed for new users and clients who want to quickly create and execute a scenario in SafeBreach that includes two simulated attacks.

✅ Step 1: Choose Simulators

Why this matters: Simulators are the agents that execute attack steps in your scenario.

1. List available simulators Use the following endpoint: GET /api/config/v1/accounts/:accountId/nodes You may add filters like: ?isConnected=true&name=HQ-Simulator
2. Copy relevant simulator IDs You’ll use these in your scenario request inside the attackerFilter.

✅ Step 2: Choose Attacks (Moves)

Why this matters: In SafeBreach, attacks are referred to as moves.

1. List available attacks (moves) Use this endpoint: GET /api/content/v2/accounts/:accountId/moves?details=true
2. Filter by criteria like status, category, etc. Example: ?details=true&status=published
3. Take note of each move’s uuid These will be inserted into the scenario steps.

✅ Step 3: Create a Scenario

Use the following endpoint:

POST /api/config/v2/accounts/:accountId/plans

Basic JSON Payload:

 
{
  "name": "New Scenario",
  "description": "Runs two critical attacks for validation",
  "accountId": 123456789,
  "actions": [
    {
      "id": 1,
      "type": "multiAttack",
      "data": {
        "uuid": "uuid-of-move-1"
      }
    },
    {
      "id": 2,
      "type": "multiAttack",
      "data": {
        "uuid": "uuid-of-move-2"
      }
    }
  ],
  "edges": [
    { "from": 1, "to": 2, "condition": true }
  ]
}

Optional targeting (add to each step if needed):

"attackerFilter": { "operator": "is", "values": ["<simulatorId>"], "name": "simulators" }

✅ Step 4: Execute the Scenario

Once the scenario is created, queue it for execution:

POST /api/orch/v4/accounts/:accountId/queue

Payload:

"plan": { "planId": "id-of-the-scenario", "name": "name-of-the-scenario" }

📝 Best Practice Tips

• Use separate staging simulators for testing.
• Make sure API tokens are secure and access is scoped.
• Document scenario intent (use description) for audit clarity.
• Scenarios can be reused and extended with more actions and conditions.