{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"post","examples":{"codes":[]},"results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Bulk deletion of files","type":"endpoint","slug":"bulk-deletion-of-files","excerpt":"","body":"Delete files in bulk by specifying their IDs.\n\n##Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/bulk/files/delete\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request body\n\nIn the request body, enter the IDs of the files you want to delete.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`file_ids`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The ids of the file you are deleting. Separate file IDs with a comma.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/bulk/files/delete HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\",\n      \"language\": \"http\",\n      \"name\": \"HTTP\"\n    },\n    {\n      \"code\": \"curl -X POST \\\\\\n  https://cgc-api.sbgenomics.com/v2/bulk/files/delete \\\\\\n  -H 'Content-Type: application/json' \\\\\\n  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \\\\\\n  -d '{\\n    \\\"file_ids\\\" : [\\\"568e69abe9b0307bc0412345\\\", \\\"568e69abe9b0307bc0498765\\\"]\\n}'\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ]\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 CGC [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \" Content-Type\\n*required* \",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"items\\\": [\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345\\\",\\n                \\\"id\\\": \\\"568e69abe9b0307bc0412345\\\",\\n                \\\"name\\\": \\\"1000G_phase1.snps.high_confidence.b37.vcf\\\",\\n                \\\"size\\\": 7313069069,\\n                \\\"project\\\": \\\"rfranklin/my-projects\\\",\\n                \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"storage\\\": {\\n                    \\\"type\\\": \\\"PLATFORM\\\"\\n                },\\n                \\\"origin\\\": {},\\n                \\\"tags\\\": [],\\n                \\\"metadata\\\": {}\\n            }\\n        },\\n        {\\n            \\\"resource\\\": {\\n                \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765\\\",\\n                \\\"id\\\": \\\"568e69abe9b0307bc0498765\\\",\\n                \\\"name\\\": \\\"C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf\\\",\\n                \\\"size\\\": 7313069069,\\n                \\\"project\\\": \\\"rfranklin/my-projects\\\",\\n                \\\"created_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"modified_on\\\": \\\"2018-03-01T10:22:44Z\\\",\\n                \\\"storage\\\": {\\n                    \\\"type\\\": \\\"PLATFORM\\\"\\n                },\\n                \\\"origin\\\": {},\\n                \\\"tags\\\": [],\\n                \\\"metadata\\\": {}\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5ad5debfe508720003bccfe7","project":"55faf11ba62ba1170021a9a7","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","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"BULK API ACTIONS","slug":"bulk-actions","order":37,"from_sync":false,"reference":false,"_id":"5ad5d392af566800032a8107","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2018-04-17T10:59:30.322Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2018-04-17T11:47:11.080Z","githubsync":"","__v":0,"parentDoc":null}

GET STARTED

TUTORIALS

GUIDES

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING DATA TO THE CGC

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

BRING YOUR TOOLS

DOCKER

DESCRIBE YOUR TOOL (LEGACY)

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP (LEGACY)

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API CLIENTS

SB Command Line Interface

API Reference

EDIT AN APP

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

DATA STUDIO

SBFS (Beta)

SBFS Command Reference

postBulk deletion of files

Delete files in bulk by specifying their IDs. ##Request [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/bulk/files/delete", "language": "text", "name": "Path" } ] } [/block] ##Request body In the request body, enter the IDs of the files you want to delete. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`file_ids`", "0-1": "string", "0-2": "The ids of the file you are deleting. Separate file IDs with a comma." }, "cols": 3, "rows": 1 } [/block] ###Example request [block:code] { "codes": [ { "code": "POST /v2/bulk/files/delete HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74", "language": "http", "name": "HTTP" }, { "code": "curl -X POST \\\n https://cgc-api.sbgenomics.com/v2/bulk/files/delete \\\n -H 'Content-Type: application/json' \\\n -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \\\n -d '{\n \"file_ids\" : [\"568e69abe9b0307bc0412345\", \"568e69abe9b0307bc0498765\"]\n}'", "language": "curl", "name": "cURL" } ] } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": " X-SBG-Auth-Token\n*required* ", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": " Content-Type\n*required* ", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response.](ref:api-status-codes). [block:code] { "codes": [ { "code": "{\n \"items\": [\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345\",\n \"id\": \"568e69abe9b0307bc0412345\",\n \"name\": \"1000G_phase1.snps.high_confidence.b37.vcf\",\n \"size\": 7313069069,\n \"project\": \"rfranklin/my-projects\",\n \"created_on\": \"2018-03-01T10:22:44Z\",\n \"modified_on\": \"2018-03-01T10:22:44Z\",\n \"storage\": {\n \"type\": \"PLATFORM\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {}\n }\n },\n {\n \"resource\": {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765\",\n \"id\": \"568e69abe9b0307bc0498765\",\n \"name\": \"C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf\",\n \"size\": 7313069069,\n \"project\": \"rfranklin/my-projects\",\n \"created_on\": \"2018-03-01T10:22:44Z\",\n \"modified_on\": \"2018-03-01T10:22:44Z\",\n \"storage\": {\n \"type\": \"PLATFORM\"\n },\n \"origin\": {},\n \"tags\": [],\n \"metadata\": {}\n }\n }\n ]\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]