testRuns

Cancel a queued or running batch

Changed on

Cancel all queued or running runs in a prior group-run batch. Finished runs are left unchanged, making the endpoint idempotent when the batch has already completed.

post/v1/batches/{batchId}/cancel

Request

  • Base URL
    https://tester.army/api
  • Auth
    none declared. Required headers: Authorization

Path parameters

batchIdstring uuid required

Batch ID

Headers

Authorizationstring required

API key authentication using Bearer token format

Response

Batch cancellation summary

batchIdstring uuid required
cancelledinteger required
alreadyFinishedinteger required
cancelledRunIdsstring[] required
alreadyFinishedRunIdsstring[] required

Changes

    • info

      api operation id cancel-a-queued-or-running-batch removed and replaced with testRuns_cancelAQueuedOrRunningBatch