{"_id":"5b0e13ffc4664e0003c75b6d","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":0,"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"project":"5b0e13ffc4664e0003c75a66","parentDoc":null,"user":"554340dfb7f4540d00fcef1d","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T21:11:08.140Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"delete","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":17,"body":"This call deletes a project from the Platform. It can only be successfully made if you have admin status for the project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Warning\",\n  \"body\": \"Deleting a project completely erases the project and any of its related data from the CGC.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Referring to your project\",\n  \"body\": \"Note that `project_owner` is always case-sensitive, and that `project` is not the project's name but its short name. For full details of identifying objects using the API, please see the [API Overview](doc:the-api)\"\n}\n[/block]\n ##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DELETE /v2/projects/RFranklin/my-project HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X DELETE -H \\\"X-SBG-Auth-Token: ce7ae5ab85e946599298e88a3430fba0\\\" 'http://f4c-api.sbgenomics.com//v2/projects/RFranklin/my-project'\",\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<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"0-1\": \"Your Platform [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\": \"`project`\",\n    \"1-0\": \"`project_owner`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The [short name](doc:the-api#section-identifying-projects-users-apps-files-and-tasks) of the project you are deleting.\",\n    \"1-1\": \"The owner of the project you are deleting.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Response\n[See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/1.1 204 No Content\\nDate: Tue, 29 Mar 2016 15:47:44 GMT\\nConnection: close\\n\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"projects/{project_owner}/{project}","slug":"delete-a-project","type":"endpoint","title":"Delete a project"}

deleteDelete a project

projects/{project_owner}/{project}

This call deletes a project from the Platform. It can only be successfully made if you have admin status for the project. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}", "language": "text", "name": "Path" } ] } [/block] [block:callout] { "type": "danger", "title": "Warning", "body": "Deleting a project completely erases the project and any of its related data from the CGC." } [/block] [block:callout] { "type": "success", "title": "Referring to your project", "body": "Note that `project_owner` is always case-sensitive, and that `project` is not the project's name but its short name. For full details of identifying objects using the API, please see the [API Overview](doc:the-api)" } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "DELETE /v2/projects/RFranklin/my-project HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X DELETE -H \"X-SBG-Auth-Token: ce7ae5ab85e946599298e88a3430fba0\" 'http://f4c-api.sbgenomics.com//v2/projects/RFranklin/my-project'", "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<span style=\"color:red\"><i>required</i></span>", "0-1": "Your Platform [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`project`", "1-0": "`project_owner`", "h-0": "Name", "h-1": "Description", "0-1": "The [short name](doc:the-api#section-identifying-projects-users-apps-files-and-tasks) of the project you are deleting.", "1-1": "The owner of the project you are deleting." }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) [block:code] { "codes": [ { "code": "HTTP/1.1 204 No Content\nDate: Tue, 29 Mar 2016 15:47:44 GMT\nConnection: close\n", "language": "json" } ], "sidebar": true } [/block]