{"_id":"5643742008894c0d00031ed3","user":"55fae9d4825d5f19001fa379","editedParams":true,"parentDoc":null,"project":"55faeacad0e22017005b8265","category":{"_id":"5601aee850ee460d0002224c","__v":20,"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","pages":["56023786930fe1170074bd2c","561d53a09463520d00cd11ef","561d546d31d9630d001eb5d1","561d54af31d9630d001eb5d3","561d54e56386060d00e0601e","561d554d9463520d00cd11f2","564246059f4ed50d008be1af","5643712a0d9748190079defb","564372751ecf381700343c1e","5643742008894c0d00031ed3","5643747a0d9748190079df01","564375c988f3a60d00ac86b0","56437d0f0d9748190079df13","56437e83f49bfa0d002f560a","56437f7d0d9748190079df15","5643810508894c0d00031ef5","5643826f88f3a60d00ac86cb","564382de88f3a60d00ac86ce","56e07ba14685db1700d94873","56e08c9b903c7a29001d5352"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:41:28.703Z","from_sync":false,"order":10,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"editedParams2":true,"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":37,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe","5a96f89c89442e002041144b","5b3f9b7267cbc90003d283a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-11T17:00:16.361Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":" [TaskName] successfully deleted","name":""},{"code":"{\n    \"status\": \"400 Bad Request\",\n    \"message\": \"Invalid task id\"\n}","name":"","status":400,"language":"json"},{"status":401,"language":"json","code":"{\n  \"status\": \"401 Unauthorized\", \n  \"message\": \"Authentication Failed.\"\n}"}]},"settings":"","examples":{"codes":[{"name":"","code":"https://geobigdata.io/workflows/v1/tasks/doctask:0.0.1","language":"json"}]},"method":"delete","auth":"required","params":[],"url":"/workflows/v1/tasks/<task_id>:<version>"},"isReference":false,"order":11,"body":"* Deleting a task requires the version number. Only one version of a task can be deleted at a time.\n\n* Deleting a task removes the task from the task registry, but does not remove the docker image from the AWS ECS.\n\n* Only the tasks's owner can delete a task.The owner is the account, so any user within the account can delete the task. \n\n* A task cannot be deleted while docker migration for that task is in progress.\n\n* If a task version version is deleted, any workflow that uses the version of the task that's deleted, will error out. If the workflow only referred to the task name with no version number, the workflow will run the latest version of the task registered in the task registry. \n\n\n* Attempting to delete a task that doesn't exist in the task registry will result in this error message:\n\n\n\n``` \n       {\n   \t\"status\": \"400 Bad Request\",\n   \t\"message\": \"Invalid task id\"\n      }\n```","excerpt":"Delete a task from the task registry. Deleting a task requires a version number. Only one version of a task can be deleted at a time.","slug":"delete-a-task","type":"endpoint","title":"Delete a Task"}

deleteDelete a Task

Delete a task from the task registry. Deleting a task requires a version number. Only one version of a task can be deleted at a time.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

* Deleting a task requires the version number. Only one version of a task can be deleted at a time. * Deleting a task removes the task from the task registry, but does not remove the docker image from the AWS ECS. * Only the tasks's owner can delete a task.The owner is the account, so any user within the account can delete the task. * A task cannot be deleted while docker migration for that task is in progress. * If a task version version is deleted, any workflow that uses the version of the task that's deleted, will error out. If the workflow only referred to the task name with no version number, the workflow will run the latest version of the task registered in the task registry. * Attempting to delete a task that doesn't exist in the task registry will result in this error message: ``` { "status": "400 Bad Request", "message": "Invalid task id" } ```