Stop Load Test
stop_load_testStop a Load Test. By default the stop is graceful, as the Dashboard's Stop button does: each bot finishes the iteration it is on before it stops, so the last iterations complete and are reported in full. With immediate set to true the Load Test is killed instead: bots stop mid-iteration, cutting their last iterations short, and the test ends sooner. Stop gracefully unless the user asks to kill the test or the target needs relief now; a Load Test already STOPPING gracefully can still be killed with immediate. A running Load Test moves to STOPPING and then ends; one that has not started yet is canceled either way. A Load Test that has already ended is refused. The result carries its stage after the stop; follow it with get_load_test_status, and read the Test Report with get_load_test_report once it has finished.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| immediate | No | True to kill the Load Test, stopping bots mid-iteration; false or omitted to stop it gracefully, letting each bot finish its current iteration. | |
| projectId | Yes | ||
| loadTestId | Yes | The load test id, as reported by list_load_tests or launch_load_test. |