Sign in

v1

latestSwagger 2.02026-08-0484141342.3 KB
Simulations

# Create Simulation

Creates the simulation with given information

post/v1/simulations

Request body

agent_idinteger

id of the agent

agent_user_idsinteger[]

agent user ids for installable agent execution users

auto_resumeboolean

auto resume feature of the simulation, if set auto resume will be enabled for simulation

descriptionstring

description of the simulation

forceboolean

force (option to create identical simulation) available values are true and false

integrationsinteger[]

integration ids

namestring required

name of the simulation

obfuscation_methodsstring[]

TODO : add max obfuscation methods

schedule_nowboolean
template_idinteger required

id of the scope

Example request

{
  "agent_id": 3,
  "agent_user_ids": [
    1,
    2
  ],
  "description": "This simulation rocks!",
  "integrations": [
    1,
    2,
    3
  ],
  "name": "simulation - 1",
  "protocols": [
    {
      "module_id": 1,
      "protocols": [
        "http",
        "https"
      ]
    }
  ],
  "schedule": {
    "day_of_month": [
      1,
      30
    ],
    "day_of_week": [
      1,
      3
    ],
    "frequency": "WEEKLY",
    "frequency_interval": 2,
    "name": "Schedule-1"
  },
  "template_id": 1
}

Response

SimulationCreateReturnSwagger

run_immediatelyboolean
simulation_already_existboolean

Example response

{
  "run_info": {
    "browser": "BrowserUnknown",
    "id": 1,
    "status": "COMPLETED"
  },
  "simulation": {
    "agent_user_ids": [
      1,
      2
    ],
    "description": "description of the simulation",
    "id": 1,
    "integrations": [
      1,
      2,
      3
    ],
    "name": "Simulation - 1",
    "protocols": [
      {
        "module_id": 1,
        "protocols": [
          "http",
          "https"
        ]
      }
    ],
    "schedule_id": 3
  }
}