Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Simulations

Stop simulation

Stop a running simulation and all its active runs.

post/simulations/{simulationReference}/batches/{simulationRunBatchReference}

Path parameters

simulationReferencestring required

Reference ID of the scenario

simulationRunBatchReferencestring required

Reference ID of the simulation

Query parameters

projectIdstring required

Project identifier

Response

Simulation stop signal sent successfully

messagestring required

Success message

simulationRunBatchIdstring required

Reference ID of the simulation that was signaled to stop

Example response

{
  "message": "Simulation stop signal sent successfully."
}