test_runs

Cancel a test run

Cancel a test run. No new trials start, running trials are cancelled and settled results remain available.

post/api/v1/test-runs/{test_run_id}/cancel

Request

  • Base URL: https://api.cumuluslabs.io
  • URL: https://api.cumuluslabs.io/api/v1/test-runs/{test_run_id}/cancel
  • Auth: HTTP bearer

Path parameters

test_run_idstring uuid required

Request body

TestRunsCancelRequest required

Response

Cancel a test run: no new trials start and running trials are cancelled; settled results stay

owner_idstring required
environmentstring required
tenant_idstring uuid required
test_run_idstring uuid required
agent_idstring required
purpose'manual' | 'publish_gate' | 'schedule' | 'release' required
state'queued' | 'running' | 'completed' | 'cancelled' required
verdict'passed' | 'failed' | 'errored' nullable required
baseline_test_run_idstring uuid nullable required
created_atstring date-time required
finished_atstring date-time nullable required

Changes

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