Bulk deletion of files

Delete files in bulk by specifying their IDs.

Request

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/bulk/files/delete

Request body

In the request body, enter the IDs of the files you want to delete.

Key	Data type	Description
file_ids	string	The ids of the file you are deleting. Separate file IDs with a comma.

Example request

HTTP

POST /v2/bulk/files/delete HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl -X POST \
  https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/bulk/files/delete \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74' \
  -d '{
    "file_ids" : ["5a97d4741c94edbe85904909", "5a97d4741c94edbe8590493b"]
}'

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.
Content-Type required	application/json

Response

See a list of response codes that may be contained in the body of the response..

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/5a97d4741c94edbe85904936",
                "id": "5a97d4741c94edbe85904909",
                "name": "1000G_phase1.snps.high_confidence.b37.vcf",
                "size": 7313069069,
                "project": "rfranklin/my-projects",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        },
        {
            "resource": {
                "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/files/5a97d4741c94edbe85904936",
                "id": "5a97d4741c94edbe8590493b",
                "name": "C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf",
                "size": 7313069069,
                "project": "rfranklin/my-projects",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        }
    ]
}