simulation

Cancel running simulation

Initiate cancellation of running simulation.

Non-blocking: sends SIGTERM and returns immediately with status='cancelling'. Background watcher handles graceful shutdown (up to 30s grace period) and falls back to SIGKILL if subprocess does not respond. Status endpoint returns 'cancelling' during grace period, 'cancelled' after subprocess exits.

CR-2026-SIMVIEW-CANCEL-001

post/api/v1/simulation/cancel

Request

  • Base URL: https://api.helena.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.helena.bio/api/v1/simulation/cancel
  • Auth: HTTP bearer

Response

Successful Response

run_idstring required
statusstring required
cr_idstring nullable
progress_currentinteger
progress_totalinteger
elapsed_secondsnumber
resultobject nullable
errorstring nullable
log_linesstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.