Cancel a running workflow

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

Path

https://ga4gh-api.sb.biodatacatalyst.nhlbi.nih.gov/ga4gh/wes/v1/runs/{run_id}/cancel

Request

Example request

HTTP

POST /ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel HTTP/1.1
Host: ga4gh-api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1

cURL

curl --location --request POST 'https://ga4gh-api.sb.biodatacatalyst.nhlbi.nih.gov/ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel' \
--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0' \

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.

Path parameters

Name	Description
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

JSON

{
    "run_id": "4becc627-af34-48cd-b80c-b39574cd00d3"
}