GuidesAPIDatasets HubRelease Notes
API Reference
CGC

Get details of multiple files

post https://cgc-api.sbgenomics.com/v2

This call returns the details of multiple specified files, including file names and file metadata. The maximum number of files you can retrieve the details for per call is 100.

Request

https://cgc-api.sbgenomics.com/v2/bulk/files/get

Example request

POST v2/bulk/files/get
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75

curl -X POST \
  https://cgc-api.sbgenomics.com/v2/bulk/files/get \
  -H 'Content-Type: application/json' \
  -H 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \
  -d '{
    "file_ids" : ["568e69abe9b0307bc0412345", "568e69abe9b0307bc0498765"]
}'

Header Fields

NameDescription
X-SBG-Auth-Token
required 		Your CGC authentication token.
Content-Type
required 		application/json

Request body

KeyData typeDescription
file_idsstringThe IDs of the files you are querying for details. Separate file IDs with a comma. The maximum number of files you can retrieve the details for per call is 100.

Response

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

Response body

The response contains information about all of the files which were queried.

Example response body

{
    "items": [
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0412345",
                "id": "568e69abe9b0307bc0412345",
                "name": "1000G_phase1.snps.high_confidence.b37.vcf",
                "size": 7313069069,
                "project": "rfranklin/my-project",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        },
        {
            "resource": {
                "href": "https://cgc-api.sbgenomics.com/v2/files/568e69abe9b0307bc0498765",
                "id": "568e69abe9b0307bc0498765",
                "name": "C835.HCC1143_BL.4.contig_1_mpileup_SNPs.filtered.Somatic.hc.and_more.concat.sorted.reordered.vcf",
                "size": 5313069069,
                "project": "rfranklin/my-project",
                "created_on": "2018-03-01T10:22:44Z",
                "modified_on": "2018-03-01T10:22:44Z",
                "storage": {
                    "type": "PLATFORM"
                },
                "origin": {},
                "tags": [],
                "metadata": {}
            }
        }
        }
    ]
}
Language