Simulation
Stop simulation
Stop a running simulation.
POST/simulations//stop
Bearersession
Path parameters
simulation_idrequiredcurl -X POST 'https://omnidim.io/api/v1/simulations/{simulation_id}/stop' \ -H 'Authorization: Bearer YOUR_API_KEY'
Example response
{ "success": true, "message": "Simulation stopped successfully", "disconnect_results": { "successful_disconnects": 0, "failed_disconnects": 0, "pending_stopped": 0 } }
BearerAuthheader
AuthorizationBearer <token>Bearer token authentication. Obtain your API key from the OmniDimension dashboard.
simulation_id*integerResponse body
application/jsonStop attempted. success: true when the simulation was
running and is now stopped; success: false (still HTTP
200) when the simulation isn't in a stoppable state; the
message explains why. disconnect_results is only
present on the success path.
application/jsonsuccess?booleanmessage?stringdisconnect_results?Per-recording stop counts. Only present when success is true.
Was this page helpful?