{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"get","examples":{"codes":[]},"settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"List the contents of a volume","type":"endpoint","slug":"list-the-contents-of-a-volume","excerpt":"","body":"This call lists the contents of a specific volume. The volume is specified as `volume_id` and consists of the owner and name of a volume (for example `rfranklin/my-first-volume`).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}/list\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/storage/volumes/rfranklin/my-first-volume/list HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\\\" -H \\\"Content-type: application/json\\\" -X GET \\\"https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/list\\\"\",\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    \"1-0\": \"`Content-type`\\n_required_\",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`volume_id`\\n_required_\",\n    \"1-0\": \"`description`\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"0-2\": \"The volume that you want to query, which consists of username of the volume owner and volume name, for example `rfranklin/my-first-volume`.\",\n    \"h-2\": \"Description of value\",\n    \"1-2\": \"An optional description of this volume.\",\n    \"2-0\": \"`service`\\n_required_\",\n    \"2-1\": \"Object\",\n    \"2-2\": \"This object should contain the information about the cloud service that this volume represents.\\n\\nSee the <code><a href=\\\"http://docs.sevenbridges.com/v1.0/docs/create-a-volume-v2#section-the-service-object\\\">service</code> object section</a> below for an explanation of its structure.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n###Query parameters\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\": \"`fields`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nHere's the list of available values for the `fields` parameter and their descriptions:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Value\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`href`\",\n    \"1-0\": \"`location`\",\n    \"2-0\": \"`volume`\",\n    \"3-0\": \"`type`\",\n    \"4-0\": \"`metadata`\",\n    \"5-0\": \"`_all`\",\n    \"0-1\": \"Shows only the href of each returned item.\",\n    \"1-1\": \"Shows only the location (path) within the volume for each returned item.\",\n    \"2-1\": \"Shows only the volume on which the returned item is located, in the `<user-name>/<volume-name>` format.\",\n    \"3-1\": \"Shows only the type of the returned item. Type is `s3` for items stored on an AWS S3 bucket and `gcp` for items stored on a Google Cloud Storage bucket.\",\n    \"4-1\": \"Shows only the storage-provider-generated metadata for each of the returned items.\",\n    \"5-1\": \"Shows all standard fields for each returned item, with the addition of corresponding metadata.\"\n  },\n  \"cols\": 2,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See a list of CGC-specific response codes that may be contained in the body of the response](ref:api-status-codes).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example response body\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=100\\\",\\n  \\\"limit\\\": \\\"100\\\",\\n  \\\"continuation_token\\\": \\\"ChhpbnB1dC1eaTxlcy8yMC5pbnR4cnZhbHM=\\\",\\n  \\\"truncated\\\": true,\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/object?location=20.intervals\\\",\\n      \\\"location\\\": \\\"20.intervals\\\",\\n      \\\"volume\\\": \\\"rfranklin/my-first-volume\\\",\\n      \\\"type\\\": \\\"gcs\\\",\\n      \\\"metadata\\\": {\\n        \\\"bucket\\\": \\\"example-bucket\\\",\\n        \\\"contentType\\\": \\\"binary/octet-stream\\\",\\n        \\\"crc32c\\\": \\\"P1TVmQ==\\\",\\n        \\\"etag\\\": \\\"CNjwesvWvc0CEAE=\\\",\\n        \\\"generation\\\": 1466668676135000,\\n        \\\"id\\\": \\\"example-bucket/input-files/20.intervals/1463468676135000\\\",\\n        \\\"kind\\\": \\\"storage#object\\\",\\n        \\\"md5Hash\\\": \\\"0SgvPZ/j5a/TOHKpzkfX0A==\\\",\\n        \\\"mediaLink\\\": \\\"https://www.googleapis.com/download/storage/v1/b/example-bucket/o/input-files%2F20.intervals?generation=1463468676135000&alt=media\\\",\\n        \\\"metageneration\\\": 1,\\n        \\\"name\\\": \\\"input-files/20.intervals\\\",\\n        \\\"selfLink\\\": \\\"https://www.googleapis.com/storage/v1/b/example-bucket/o/input-files%2F20.intervals\\\",\\n        \\\"size\\\": 9,\\n        \\\"storageClass\\\": \\\"STANDARD\\\",\\n        \\\"timeCreated\\\": {\\n          \\\"value\\\": 1466668676132,\\n          \\\"dateOnly\\\": false,\\n          \\\"timeZoneShift\\\": 0\\n        },\\n        \\\"updated\\\": {\\n          \\\"value\\\": 1466668676132,\\n          \\\"dateOnly\\\": false,\\n          \\\"timeZoneShift\\\": 0\\n        },\\n        \\\"timeStorageClassUpdated\\\": \\\"2016-06-23T07:57:56.132Z\\\"\\n      }\\n    }\\n  ],\\n  \\\"prefixes\\\": [],\\n  \\\"links\\\": {\\n    \\\"next\\\": \\\"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=2&continuation_token=ChhpbnB1dC1eaTxlcy8yMC5pbnR4cnZhbHM%3D\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n##Interpreting the response body\n* `href`: Use the information contained in the `href` to make another [request](ref:get-details-of-a-file-within-the-volume) to obtain more details about a specific object within a volume.","updates":[],"order":94,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5931c17b86334d000fcaabc5","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":["56312d239ead230d00a188f2","56312e0d82d96a0d00b0fb08","56315777fc94aa0d00e9b553","56315b779ead230d00a1894a","5631657c9c25801700dac34f","56317884fc94aa0d00e9b586","56318386c3b04b0d00ba9bb9","563240ccdcc27a170082363b","563240dfbddb091700ad5e82","563240edfe9acd1900cc1d10","56324504fa40240d007c8d5f","56324b30c3b04b0d00ba9c96","563273ae45f2cb0d006be3fa","563273c08c9cda0d0025266d","563273cc38f8aa0d00d30f55","563273d838f8aa0d00d30f59","5632740945f2cb0d006be3fc","56327411df556c0d00cd0905","5632741b8c9cda0d0025266f","563274ea10b6040d008793d8","5632757cdf556c0d00cd0908","563275b710b6040d008793da","563275f938f8aa0d00d30f60","5632762fb904a10d0032f6fc","5632767110b6040d008793dd","563276c0b904a10d0032f700","5632770162c48a0d00334d53","5632843d8c9cda0d00252698","5632846e62c48a0d00334d78","56328a7e49e16d0d00122420","56328aaf49e16d0d00122425","56328b2238f8aa0d00d30f88","56328b6c8c9cda0d002526a2","56328c0710b6040d008793ff","56328c3710b6040d00879401","56328c5938f8aa0d00d30f8c","56328c90b904a10d0032f722","56328cc449e16d0d0012242a","56328ce68c9cda0d002526a8","56328d1338f8aa0d00d30f8e","56328d5810b6040d00879407","56328d7cdf556c0d00cd092f","56328d9a10b6040d00879409","56328db438f8aa0d00d30f92","56328dd762c48a0d00334d8b","56328df649e16d0d0012242d","56328e1edf556c0d00cd0931","56328e4662c48a0d00334d8e","56328e5edf556c0d00cd0933","56328e8f8c9cda0d002526ab","56328eb3b904a10d0032f72a","56328edb38f8aa0d00d30f95","56328ef210b6040d0087940d","56328f148c9cda0d002526ad","56328f2962c48a0d00334d90","56328f54b904a10d0032f72c","56328f6c38f8aa0d00d30f98","56328f858c9cda0d002526af","56328fae62c48a0d00334d95","56328fd838f8aa0d00d30f9c","5637f069ee0ee60d0024ec18","5641ffaa9417b40d00c0fc35","564355240d9748190079dea9","5644cfeb2c74cf1900da4831","56450f856b0ca50d00f6bd8f","56706537cbb2fb0d00f7c7dd","567065bc3d29830d00376213","56706fc2cbb2fb0d00f7c87e","568bf5a1e662f40d00eee866","568c0699e662f40d00eee881","568cff0274c77f2d00d56d51","568d10f58602880d001ce277","568d2abc37b636250036b904","568d343413c5ad0d00b34efb","568d593a8602880d001ce2d3","568e64135e12fb0d00325160","568e66f05e12fb0d00325162","568e78aa5e12fb0d0032517a","569433cfd8c04d1700e5ae0c","56943723d8c04d1700e5ae14","5694393b3e9d080d00f0655d","5694e6cf953b810d008f91bc","5694f301c5c5ce0d00058e68","569502ef9797fa1900f704e7","5695063bcaa32519009c40b3","569511cccaa32519009c40d9","569557e2fcb1032d0089dfe2","569562fefcb1032d0089dfee","56956428fe18811700c9c058","569639b87596a90d0014e5a3","56a90197e590350d004b5103","56a9021e9ec7660d002e08c2"],"title":"API Reference","slug":"api","order":33,"from_sync":false,"reference":true,"_id":"55faf9aa17b9d00d00969f49","project":"55faf11ba62ba1170021a9a7","createdAt":"2015-09-17T17:34:34.937Z","version":"55faf11ba62ba1170021a9aa","__v":92},"user":"5613e4f8fdd08f2b00437620","createdAt":"2017-06-02T19:50:19.259Z","githubsync":"","__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 STUDIO

SBFS (Beta)

SBFS Command Reference

getList the contents of a volume

This call lists the contents of a specific volume. The volume is specified as `volume_id` and consists of the owner and name of a volume (for example `rfranklin/my-first-volume`). [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}/list", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "GET /v2/storage/volumes/rfranklin/my-first-volume/list HTTP/1.1\nHost: cgc-api.sbgenomics.com\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\" -H \"Content-type: application/json\" -X GET \"https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/list\"", "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": "", "1-0": "`Content-type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`volume_id`\n_required_", "1-0": "`description`", "h-0": "Key", "h-1": "Data type of value", "0-1": "String", "1-1": "String", "0-2": "The volume that you want to query, which consists of username of the volume owner and volume name, for example `rfranklin/my-first-volume`.", "h-2": "Description of value", "1-2": "An optional description of this volume.", "2-0": "`service`\n_required_", "2-1": "Object", "2-2": "This object should contain the information about the cloud service that this volume represents.\n\nSee the <code><a href=\"http://docs.sevenbridges.com/v1.0/docs/create-a-volume-v2#section-the-service-object\">service</code> object section</a> below for an explanation of its structure." }, "cols": 3, "rows": 1 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`fields`", "0-1": "String", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] Here's the list of available values for the `fields` parameter and their descriptions: [block:parameters] { "data": { "h-0": "Value", "h-1": "Description", "0-0": "`href`", "1-0": "`location`", "2-0": "`volume`", "3-0": "`type`", "4-0": "`metadata`", "5-0": "`_all`", "0-1": "Shows only the href of each returned item.", "1-1": "Shows only the location (path) within the volume for each returned item.", "2-1": "Shows only the volume on which the returned item is located, in the `<user-name>/<volume-name>` format.", "3-1": "Shows only the type of the returned item. Type is `s3` for items stored on an AWS S3 bucket and `gcp` for items stored on a Google Cloud Storage bucket.", "4-1": "Shows only the storage-provider-generated metadata for each of the returned items.", "5-1": "Shows all standard fields for each returned item, with the addition of corresponding metadata." }, "cols": 2, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of CGC-specific response codes that may be contained in the body of the response](ref:api-status-codes). [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=100\",\n \"limit\": \"100\",\n \"continuation_token\": \"ChhpbnB1dC1eaTxlcy8yMC5pbnR4cnZhbHM=\",\n \"truncated\": true,\n \"items\": [\n {\n \"href\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/object?location=20.intervals\",\n \"location\": \"20.intervals\",\n \"volume\": \"rfranklin/my-first-volume\",\n \"type\": \"gcs\",\n \"metadata\": {\n \"bucket\": \"example-bucket\",\n \"contentType\": \"binary/octet-stream\",\n \"crc32c\": \"P1TVmQ==\",\n \"etag\": \"CNjwesvWvc0CEAE=\",\n \"generation\": 1466668676135000,\n \"id\": \"example-bucket/input-files/20.intervals/1463468676135000\",\n \"kind\": \"storage#object\",\n \"md5Hash\": \"0SgvPZ/j5a/TOHKpzkfX0A==\",\n \"mediaLink\": \"https://www.googleapis.com/download/storage/v1/b/example-bucket/o/input-files%2F20.intervals?generation=1463468676135000&alt=media\",\n \"metageneration\": 1,\n \"name\": \"input-files/20.intervals\",\n \"selfLink\": \"https://www.googleapis.com/storage/v1/b/example-bucket/o/input-files%2F20.intervals\",\n \"size\": 9,\n \"storageClass\": \"STANDARD\",\n \"timeCreated\": {\n \"value\": 1466668676132,\n \"dateOnly\": false,\n \"timeZoneShift\": 0\n },\n \"updated\": {\n \"value\": 1466668676132,\n \"dateOnly\": false,\n \"timeZoneShift\": 0\n },\n \"timeStorageClassUpdated\": \"2016-06-23T07:57:56.132Z\"\n }\n }\n ],\n \"prefixes\": [],\n \"links\": {\n \"next\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=2&continuation_token=ChhpbnB1dC1eaTxlcy8yMC5pbnR4cnZhbHM%3D\"\n }\n}", "language": "json" } ], "sidebar": true } [/block] ##Interpreting the response body * `href`: Use the information contained in the `href` to make another [request](ref:get-details-of-a-file-within-the-volume) to obtain more details about a specific object within a volume.