{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","params":[]},"next":{"description":"","pages":[]},"title":"Get a URL for downloading a file","type":"endpoint","slug":"get-an-url-for-downloading-a-file","excerpt":"","body":"This call will return a URL for downloading a file. Before you can download a file, please make sure your project contains it. Learn more from this [tutorial](doc:download-a-file-tutorial).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336eb7cf1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1\\nHost: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5336eb7cf1273259740f75\",\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\": \"Key\",\n    \"h-1\": \"Description of value\",\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  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`object_id`\",\n    \"0-1\": \"The ID of the DRS object i.e. the ID of the file in your project.\",\n    \"0-2\": \"If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\\n\\n_default_: `false`\",\n    \"1-0\": \"`access_id`\",\n    \"1-1\": \"An arbitrary string to be passed to the /access method to get an AccessURL.\\n\\nNote: use the [Get info about a DRS object](doc:get-info-about-a-drs-object) call to retrieve the `access_id`parameter.\"\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](doc:api-status-codes). \n\n###Response body\n\nThe response object contains the link for downloading the file.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`url`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The link for downloading the file.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"url\\\": \\\"https://tcga-controlled.s3.amazonaws.com/3a5968d3-2a4f-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSWMR7UZQ%2F20191029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=ALEKSANDARGAZIBARA&X-Amz-Signature=af07361682c2b11a6537c99152b3e6e9d1198cafd9ee0bedcc4ae989d22de768\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example response body\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5db6f0c43291d200319bf2ed","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":"DRS API","slug":"drs-api","order":39,"from_sync":false,"reference":false,"_id":"5db6f03a6e187c006f667fa4","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","createdAt":"2019-10-28T13:42:18.754Z","__v":0},"user":"566590c83889610d0008a253","createdAt":"2019-10-28T13:44:36.413Z","__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 CRUNCHER

SBFS (Beta)

SBFS Command Reference

getGet a URL for downloading a file

This call will return a URL for downloading a file. Before you can download a file, please make sure your project contains it. Learn more from this [tutorial](doc:download-a-file-tutorial). [block:code] { "codes": [ { "code": "https://cgc-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9c/access/aws-us-east-1 HTTP/1.1\nHost: cgc-ga4gh-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5336eb7cf1273259740f75", "language": "http", "name": null }, { "code": "GET /ga4gh/drs/v1/objects/5c24cd21e4b08832c2f94e9/access/aws-us-east-1c HTTP/1.1\nHost: cgc-ga4gh-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5336eb7cf1273259740f75", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your CGC [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "h-2": "Description of value", "0-0": "`object_id`", "0-1": "The ID of the DRS object i.e. the ID of the file in your project.", "0-2": "If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\n\n_default_: `false`", "1-0": "`access_id`", "1-1": "An arbitrary string to be passed to the /access method to get an AccessURL.\n\nNote: use the [Get info about a DRS object](doc:get-info-about-a-drs-object) call to retrieve the `access_id`parameter." }, "cols": 2, "rows": 2 } [/block] ##Response [See a list of CGC-specific response codes that may be contained in the body of the response](doc:api-status-codes). ###Response body The response object contains the link for downloading the file. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`url`", "0-1": "String", "0-2": "The link for downloading the file." }, "cols": 3, "rows": 1 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"url\": \"https://tcga-controlled.s3.amazonaws.com/3a5968d3-2a4f-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSWMR7UZQ%2F20191029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=ALEKSANDARGAZIBARA&X-Amz-Signature=af07361682c2b11a6537c99152b3e6e9d1198cafd9ee0bedcc4ae989d22de768\"\n}", "language": "json", "name": "Example response body" } ], "sidebar": true } [/block]