Skip to main content

Stop a queued or running test run of an agent

POST 
https://platform.docana.com/api/v1/agents/:agentId/test-runs/:runId/stop/

Runs with status QUEUED or RUNNING can be stopped; a queued run is cancelled before the worker ever claims it. Stopping aborts the agent executions of the run thread, then marks the run as ERROR with the reason Cancelled by user. The terminal write is a compare-and-set: if the run finishes first, the response is 409 and the completed result stands. The applicationId query parameter is optional: when omitted, it is derived from the run itself.

Request​

Responses​

The test run was cancelled