{"_id":"5601ba086811d00d00ceb4a4","__v":1,"user":"55fae9d4825d5f19001fa379","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":34,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"editedParams":true,"editedParams2":true,"category":{"_id":"5601afa02499c119000faf19","pages":["5601b42b6811d00d00ceb49b","5601b63c9137690d003357cb","5601b7b49137690d003357d0","5601b82a81a9670d006d166b","5601b84350ee460d00022261","5601b8c281a9670d006d166e","5601b9146811d00d00ceb4a3","5601ba086811d00d00ceb4a4","5601baf650ee460d00022264","5601bf6d7916060d00760b00","561d578e9242920d00df9f47","561d57ec2d6a450d00f0512d","561d58449242920d00df9f53","56438be2f49bfa0d002f561e","56438e101ecf381700343c48","5643902708894c0d00031f14","564391d1c92c470d002deb03","564394529eebf70d00490d35","56f194243eb62a34003e9fef"],"project":"55faeacad0e22017005b8265","__v":19,"version":"55faeacad0e22017005b8268","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:44:32.525Z","from_sync":false,"order":9,"slug":"s3-storage-service-guide","title":"S3 Storage Service Guide"},"parentDoc":null,"project":"55faeacad0e22017005b8265","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T20:28:56.464Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"json"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"  {\n              \"url\": “{full s3 url to object}\",\n              \"success\": true\n            }","name":""}]},"settings":"","auth":"required","params":[{"_id":"5601ba086811d00d00ceb4a5","ref":"","in":"query","required":false,"desc":"/{account_prefix}/{folder}/{object}`) ...  full path to an object on S3. This includes the users account prefix.","default":"","type":"string","name":"object_name"}],"url":"/s3creds/v1/object/url?object_name=folder/file.txt"},"isReference":false,"order":9,"body":"[block:textarea]\n{\n  \"text\": \"Permissions Required: AUTH_USER\\n\\nNote: The object must exist in the database, raises 404.\\n\\nWhen a request is successful, the response body will provide the download URL.\",\n  \"sidebar\": true\n}\n[/block]","excerpt":"Get a temporary download URL for an object using the GBDX S3 storage service","slug":"temp-download-url-for-an-object","type":"endpoint","title":"Get Download URL for an object"}

getGet Download URL for an object

Get a temporary download URL for an object using the GBDX S3 storage service

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

object_name:
string
/{account_prefix}/{folder}/{object}`) ... full path to an object on S3. This includes the users account prefix.

Result Format


Documentation

[block:textarea] { "text": "Permissions Required: AUTH_USER\n\nNote: The object must exist in the database, raises 404.\n\nWhen a request is successful, the response body will provide the download URL.", "sidebar": true } [/block]