Cancel a running workflow

This call cancels a running workflow. Only runs whose status is QUEUED, INITIALIZING or RUNNING may be cancelled.

https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/cancel

Request

Example request

POST /ga4gh/wes/v1/runs/5a4c3582-cbe1-5ba4-8945-af338969c510/cancel HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl --location --request POST 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/5a4c3582-cbe1-5ba4-8945-af338969c510/cancel' \
--header 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your authentication token.

Path parameters

NameDescription
run_id
required
The ID of the workflow you are canceling.

Response

See a list of response codes that may be contained in the body of the response.

Example response body

{
    "run_id": "e3ed2ce1-8f8c-14a9-bd71-4cebd2ee441f"
}

Did this page help you?