Data Hub
Runs

Cancel a run's queued files

Requires scope `runs:reprocess`. Takes every `queued` file of the run out of the reprocessing queue. Each one becomes `failed` with a message that says the reprocess was cancelled, and can be reprocessed again. Files that have already started are not affected. Works on a soft-deleted run too. `files_cancelled` is 0 when no file was queued.

POST
/instruments/{instrumentId}/runs/{runId}/cancel-queued

Requires scope runs:reprocess. Takes every queued file of the run out of the reprocessing queue. Each one becomes failed with a message that says the reprocess was cancelled, and can be reprocessed again. Files that have already started are not affected. Works on a soft-deleted run too. files_cancelled is 0 when no file was queued.

Authorization

bearerAuth
AuthorizationBearer <token>

Personal access tokens begin with dhub_… and are restricted by their assigned scopes.

In: header

Path Parameters

instrumentId*string
runId*string

The run ID. Spaces at the start or end are ignored.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/instruments/plate-reader/runs/run-2026-001/cancel-queued"
{  "instrument_id": "string",  "run_id": "string",  "files_cancelled": 0}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}
{  "error": {    "code": "string",    "message": "string",    "details": {      "property1": null,      "property2": null    }  }}