{"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://cavatica-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: cavatica-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://cavatica-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":"5f8944afbbc548006bca37c6","createdAt":"2020-10-16T06:58:55.147Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":25,"from_sync":false,"reference":false,"_id":"5f893e508c9862002d0614a9","createdAt":"2020-10-16T06:31:44.321Z","version":"5773dcfc255e820e00e1cd50","project":"5773dcfc255e820e00e1cd4d","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","__v":0,"parentDoc":null}

Get started

Cavatica Projects

Find apps

Bring your private data

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

Kids First studies

Cavatica Datasets

Cavatica API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

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://cavatica-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: cavatica-ga4gh-api.sbgenomics.com\nX-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1\n", "language": "http", "name": null }, { "code": "curl --location --request POST 'https://cavatica-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]