v1

latestSwagger 2.02026-08-0484141342.3 KB
Simulations

# Update Simulation

Updates the simulation with given information

put/v1/simulations/{Id}

Path parameters

Idinteger required

Simulation ID (URI parameter)

Request body

schedule_nowboolean

Example request

{
  "schedule": {
    "day_of_month": [
      1,
      30
    ],
    "day_of_week": [
      1,
      3
    ],
    "frequency": "WEEKLY",
    "frequency_interval": 2,
    "name": "Schedule-1"
  }
}

Response

SimulationUpdateReturnSwagger

run_immediatelyboolean

Example response

{
  "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
  }
}