Get 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.

https://cgc-ga4gpi.sbgenomics.com/ga4gh/drs/v1/objects/{object_id}/access/{access_id}

Request

Example request

GET ga4gh/drs/v1/objects/4c33ae65e4b032ce3d94e9c/access/aws-us-east-1 HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

GET /ga4gh/drs/v1/objects/4c33ae65e4b032ce3d94e9c/access/aws-us-east-1c HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

Header Fields

Key	Description of value
`X-SBG-Auth-Token` required	Your CGC authentication token.

Path parameters

Key	Description of value
`object_id`	The ID of the DRS object i.e. the ID of the file in your project.
`access_id`	An arbitrary string to be passed to the /access method to get an AccessURL. Note: use the Get info about a DRS object call to retrieve the `access_id`parameter.

Response

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

Response body

The response object contains the link for downloading the file.

Key	Data type of value	Description of value
`url`	String	The link for downloading the file.

Example response body

{
    "url": "https://bucket.s3.amazonaws.com/3a5968d3-1e5r-415a-9b01-7f9f9afbad9f/7ee5a028a6bc0812b1b10aec200b57ac_gdc_realn.bam?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAINBJ6QVTSEXAMPLE%2F201029%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20191029T141056Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&user_id=436&username=RFRANKLIN&X-Amz-Signature=af07361682c2c65e6537c99152b3d5a9d1198cafd9ab0bedcc3ed989d22de123"
}