Run a Scenario

This step-by-step guide walks you through using the SafeBreach API to identify and execute a predefined scenario (plan).

✅ Step 1: List All Scenarios

Purpose: Retrieve all available scenarios to choose one to run.

Endpoint:

GET /api/config/v2/accounts/:accountId/plans?details=false

Description: Returns a list of scenarios (plans) for the given account.

Query Parameters (optional):

• details=false (default) - returns basic metadata (ID, name)
• Set details=true to get full details for all plans

✅ Step 2: Get Scenario by ID

Purpose: Retrieve the full configuration of a specific scenario using its ID.

Endpoint:

GET /api/config/v2/accounts/:accountId/plans/:id

Description: Returns complete details of the specified scenario, including steps and filters.

✅ Step 3: Execute the Scenario

Purpose: Queue the selected scenario for execution.

Endpoint:

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

Payload Example:

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

Response: Confirms execution request; may include queue job or run ID.

📝 Best Practice Tips

• Ensure the simulator agents are online before executing.
• Use scenario descriptions to validate the scenario's goal.
• Use audit logs or execution history to track results and behavior.