{"_id":"5a82cae4582a600012809123","project":"5773dcfc255e820e00e1cd4d","version":{"_id":"5773dcfc255e820e00e1cd50","__v":26,"project":"5773dcfc255e820e00e1cd4d","createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5773df36904b0c0e00ef05ff","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-29T14:46:14.277Z","from_sync":false,"order":12,"slug":"api","title":"Cavatica API"},"user":"566590c83889610d0008a253","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-13T11:24:20.242Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"method":"get","examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":85,"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://cavatica-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: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"Content-type: application/json\\\" -X GET \\\"https://cavatica-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\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://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=100\\\",\\n  \\\"limit\\\": \\\"100\\\",\\n  \\\"continuation_token\\\": \\\"ChhpbnB1dC1maWxlcy8yMC5pbnRlcnZhbHM=\\\",\\n  \\\"truncated\\\": true,\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cavatica-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\\\": \\\"P1RVmQ==\\\",\\n        \\\"etag\\\": \\\"CNjwxsvWvc0CEAE=\\\",\\n        \\\"generation\\\": 1466668676135000,\\n        \\\"id\\\": \\\"example-bucket/input-files/20.intervals/1466668676135000\\\",\\n        \\\"kind\\\": \\\"storage#object\\\",\\n        \\\"md5Hash\\\": \\\"0SgvLZ/y5a/TOHXpzkfX0A==\\\",\\n        \\\"mediaLink\\\": \\\"https://www.googleapis.com/download/storage/v1/b/example-bucket/o/input-files%2F20.intervals?generation=1466668676135000&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://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=2&continuation_token=ChhpbnB1dC1maWxlcy8yMC5pbnRlcnZhbHM%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.","excerpt":"","slug":"list-the-contents-of-a-volume","type":"endpoint","title":"List the contents of a volume"}

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://cavatica-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: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"Content-type: application/json\" -X GET \"https://cavatica-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] [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://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=100\",\n \"limit\": \"100\",\n \"continuation_token\": \"ChhpbnB1dC1maWxlcy8yMC5pbnRlcnZhbHM=\",\n \"truncated\": true,\n \"items\": [\n {\n \"href\": \"https://cavatica-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\": \"P1RVmQ==\",\n \"etag\": \"CNjwxsvWvc0CEAE=\",\n \"generation\": 1466668676135000,\n \"id\": \"example-bucket/input-files/20.intervals/1466668676135000\",\n \"kind\": \"storage#object\",\n \"md5Hash\": \"0SgvLZ/y5a/TOHXpzkfX0A==\",\n \"mediaLink\": \"https://www.googleapis.com/download/storage/v1/b/example-bucket/o/input-files%2F20.intervals?generation=1466668676135000&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://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/list?limit=2&continuation_token=ChhpbnB1dC1maWxlcy8yMC5pbnRlcnZhbHM%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.