{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Cancel a running workflow","type":"basic","slug":"cancel-a-running-workflow","excerpt":"","body":"This call cancels a running workflow. Only runs whose [status](doc:get-the-status-of-the-workflow-run) is `QUEUED`, `INITIALIZING` or `RUNNING` may be cancelled.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/cancel\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --location --request POST 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel' \\\\\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0' \\\\\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`run_id`\\n_required_\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the workflow you are canceling.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"run_id\\\": \\\"4becc627-af34-48cd-b80c-b39574cd00d3\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f894fccec2f53006d03f4bc","createdAt":"2020-10-16T07:46:20.264Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":39,"from_sync":false,"reference":false,"_id":"5f894c7d3b0894006477ca01","createdAt":"2020-10-16T07:32:13.051Z","version":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":47},"project":"55faf11ba62ba1170021a9a7","__v":0,"parentDoc":null}

Cancel a running workflow


This call cancels a running workflow. Only runs whose [status](doc:get-the-status-of-the-workflow-run) is `QUEUED`, `INITIALIZING` or `RUNNING` may be cancelled. [block:code] { "codes": [ { "code": "https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/cancel", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel HTTP/1.1\nHost: cgc-ga4gh-api.sbgenomics.com\nX-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1\n", "language": "http", "name": null }, { "code": "curl --location --request POST 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/4becc627-af34-48cd-b80c-b39574cd00d3/cancel' \\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0' \\", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`run_id`\n_required_", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the workflow you are canceling." }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"run_id\": \"4becc627-af34-48cd-b80c-b39574cd00d3\"\n}", "language": "json" } ], "sidebar": true } [/block]