Canceling samples
Canceling samples¶
For a short window of time immediately after sample submission, it is possible to cancel an analysis. This can be done via the web UI, CLI or the API. Samples that are canceled do not incur any charges.
By default, there is a 15 minute window following sample submission where the sample(s) can be canceled. Please contact support@gencove.com if you would like this window to be shortened or extended.
To cancel samples via the CLI, use the following command:
Note that when using the above command, all samples supplied must belong to the same project.
To cancel samples via the API, use the project-cancel-samples/<project_id>
endpoint with a list of sample_ids
as the payload. For example:
curl -X 'POST' \
'https://api.gencove.com/api/v2/project-cancel-samples/<project_id>' \
-H 'accept: application/json' \
-H 'Authorization: Api-Key <api_key>' \
-H 'Content-Type: application/json' \
-d '{
"sample_ids": [
"<sample_id>"
]
}'
This will move samples from the scheduled
status to a final user canceled
status, ensuring that they are not processed.