v1

latestSwagger 2.02026-08-0484141342.3 KB

Simulations

# Simulation List

Simulation List; Simulation ID, Simulation Name, Simulation Agent (with status), Enrichment Status, Last Prevention Result, Last Detection Result (if Available) Default limit: 25, Default offset: 0 Max limit: 50

get/v1/simulations

Query parameters

limitinteger

offsetinteger

statusstring[]

Filter with Status (one or more status): RUNNING | STOPPED | WAITING FOR THE FIRST RUN | NOT STARTED | COMPLETED

simulation_namestring

Filter with Simulation name.

agent_namestring

Filter with Agent name.

agent_idinteger

Filter with Agent id.

template_namestring

Filter with Template name.

template_idinteger

Filter with Template id.

prevention_result_lteinteger

Filter with Prevention Result Less Than or Equals

prevention_result_gteinteger

Filter with Prevention Result Greater Than or Equals

detection_result_lteinteger

Filter with Detection Result Less Than or Equals

detection_result_gteinteger

Filter with Detection Result Greater Than or Equals

Response

SimulationsResponse

Example response

{
  "pages": {
    "limit": 20,
    "total_count": 100
  },
  "simulations": [
    {
      "agent": {
        "id": 1,
        "name": "Agent-1",
        "status": "alive | dead | expired",
        "type": "QuickEmail | Browser | Installable Agent | Windows | Linux | MacOS",
        "version": "3.4.0.0"
      },
      "detection_analysis": {
        "integrations": [
          {
            "id": 1,
            "product_name": "Crowdstrike"
          }
        ]
      },
      "last_detection_security_score": 50,
      "last_prevention_security_score": 50,
      "simulation_id": 1,
      "simulation_name": "Simulation-1",
      "status": "RUNNING | COMPLETED | STOPPED | NOT STARTED | SCHEDULED | WAITING FOR THE FIRST RUN",
      "template_id": 1,
      "template_name": "Template #1",
      "updated_at": 1654623047
    }
  ]
}