{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"patch","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Update a volume","type":"endpoint","slug":"update-a-volume-v2","excerpt":"","body":"This call updates the details of a specific volume.\n\nLearn more about using the Volumes API for [Amazon S3](aws-cloud-storage-tutorial) and for [Google Cloud Storage](google-cloud-storage-tutorial).\n\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_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\": \"PATCH /v2/storage/volumes/rfranklin/output HTTP/1.1\\nHost: cgc-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\\nContent-Type: application/json\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"curl --data ':::at:::patch-volume.json' -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"Content-Type: application/json\\\" -X PATCH \\\"https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/output\\\"\",\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 \"h-0\": \"Key\",\n \"h-1\": \"Description of value\",\n \"0-0\": \"`volume_id`\",\n \"0-1\": \"The volume that you want to update.\"\n },\n \"cols\": 2,\n \"rows\": 1\n}\n[/block]\n###Request body\n\nIn the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.\n[block:parameters]\n{\n \"data\": {\n \"1-0\": \"`description`\",\n \"h-0\": \"Key\",\n \"h-1\": \"Data type of value\",\n \"1-1\": \"String\",\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=\\\"#section-the-service-object\\\">service</code> object section</a> below for an explanation of its structure.\",\n \"0-0\": \"`access_mode`\",\n \"0-1\": \"String\",\n \"0-2\": \"Signifies whether this volume should be used for read-write (`\\\"RW\\\"`) or read-only (`\\\"RO\\\"`) operations.\\n\\nThe access mode is consulted independently of the credentials granted to Seven Bridges when the volume was created, so it is possible to use a read-write credentials to register both read-write and read-only volumes using it.\\n\\n_default:_ `\\\"RW\\\"`\"\n },\n \"cols\": 3,\n \"rows\": 3\n}\n[/block]\n###The `service` object\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Key\",\n \"h-1\": \"Data type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`credentials`\",\n \"0-1\": \"Object\",\n \"0-2\": \"Contains credentials for the underlying cloud provider.\\n\\n* AWS IAM user:\\n * [`access-key-id`](#access-key-id)\\n * [`secret_access-key`](#secret-access-key)\\n\\nFor Google Cloud Storage, these credentials are:\\n\\n* [`client_email`](#client-email)\\n* [`private_key`](#private-key)\",\n \"1-0\": \"<a name=\\\"access-key-id\\\"></a>`access_key_id`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\\n_required_\",\n \"1-1\": \"String\",\n \"1-2\": \"AWS access key ID of the IAM user shared with Seven Bridges to access this bucket.\",\n \"2-0\": \"<a name=\\\"secret-access-key\\\"></a>`secret_access_key`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\\n_required_\",\n \"2-1\": \"String\",\n \"2-2\": \"AWS secret access key of the IAM user shared with Seven Bridges to access this bucket.\",\n \"3-0\": \"<a name=\\\"client-email\\\"></a>`client_email`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `gcs`_</span>\\n_required_\",\n \"3-1\": \"String\",\n \"3-2\": \"Google Cloud Platform user email.\",\n \"4-0\": \"<a name=\\\"private-key\\\"></a>`private_key`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `gcs`_</span>\\n_required_\",\n \"4-1\": \"String\",\n \"4-2\": \"Google Cloud Platform private key.\",\n \"6-0\": \"`properties`\",\n \"6-1\": \"Object\",\n \"6-2\": \"Contains properties of specific service.\",\n \"7-0\": \"`sse_algorithm`\\n\\n_applies to type: `s3`_\",\n \"7-1\": \"String\",\n \"7-2\": \"Use default AES256 server-side encryption when writing to this bucket. (Support for SSE-KMS and SSE-C will be added in a later release.)\\n\\nCan be:\\n * AES256 (default)\\n * `aws:kms`\\n * null\\n\\n_default: AES256_\",\n \"8-0\": \"`sse_aws_kms_key_id`\\n\\n<span style=\\\"color:#871818\\\">_applies to type: `s3`_</span>\",\n \"8-1\": \"String\",\n \"8-2\": \"Provide your AWS KMS ID here if you specify `aws:kms` as your `sse_algorithm`. Learn more about [AWS KMS](https://aws.amazon.com/documentation/kms/).\",\n \"5-0\": \"`endpoint`\",\n \"5-1\": \"String\",\n \"5-2\": \"Cloud provider API endpoint to use when accessing this bucket. Also includes [FIPS endpoints](doc:amazon-web-services-simple-storage-service-aws-s3-volumes#amazon-s3-fips-endpoints) if you need to use one.\"\n },\n \"cols\": 3,\n \"rows\": 9\n}\n[/block]\n###Example request body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"description\\\": null,\\n \\\"service\\\": {\\n \\\"properties\\\": {\\n \\\"sse_algorithm\\\": \\\"AES256\\\"\\n }\\n },\\n}\\n\",\n \"language\": \"text\",\n \"name\": \"Example request body\"\n }\n ]\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\nThe response object contains information about the specified volume. The information is structured using the following key-value pairs:\n\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\": \"`active`\",\n \"1-0\": \"`id`\",\n \"0-1\": \"Boolean\",\n \"1-1\": \"String\",\n \"2-1\": \"String\",\n \"2-0\": \"`name`\",\n \"3-0\": \"`description`\",\n \"3-1\": \"String\",\n \"4-0\": \"`service`\",\n \"4-1\": \"Object\",\n \"5-0\": \"`created_on`\",\n \"5-1\": \"String\",\n \"6-0\": \"`modified_on`\",\n \"6-1\": \"String\",\n \"0-2\": \"If a volume is deactivated, this field will be set to false\",\n \"1-2\": \"ID of this volume, containing owner/name\",\n \"2-2\": \"Name of the volume.\",\n \"3-2\": \"The description of this volume.\",\n \"4-2\": \"This object more closely describes the mapping of the volume to the cloud service where the data is stored.\\n\\nSee the <code><a href=\\\"#section-the-service-object\\\">service</code> object section</a> above for an explanation of its structure.\",\n \"5-2\": \"The date and time this volume was created.\",\n \"6-2\": \"The date and time this volume was last modified.\"\n },\n \"cols\": 3,\n \"rows\": 7\n}\n[/block]\n\n###Example response body\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"href\\\": \\\"https://api.sbgenomics.com/v2/storage/volumes/rfranklin/output\\\",\\n \\\"id\\\": \\\"rfranklin/output\\\",\\n \\\"name\\\": \\\"output\\\",\\n \\\"access_mode\\\": \\\"RW\\\",\\n \\\"service\\\": {\\n \\\"type\\\": \\\"S3\\\",\\n \\\"bucket\\\": \\\"output_bucket\\\",\\n \\\"prefix\\\": \\\"outfiles\\\",\\n \\\"endpoint\\\": \\\"s3.amazonaws.com\\\",\\n \\\"credentials\\\": {\\n \\\"access_key_id\\\": \\\"AKIAJRC7TPMRMDKOFXGA\\\"\\n },\\n \\\"properties\\\": {\\n \\\"sse_algorithm\\\": \\\"AES256\\\"\\n }\\n },\\n \\\"created_on\\\": \\\"2016-06-30T08:14:02Z\\\",\\n \\\"modified_on\\\": \\\"2016-06-30T08:14:02Z\\\",\\n \\\"active\\\": true\\n}\",\n \"language\": \"json\"\n }\n ],\n \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"success\",\n \"body\": \"Note that you cannot view volumes that you have created via the visual interface. However, you can see all your volumes by making the call to [list volumes](list-volumes-v2).\"\n}\n[/block]","updates":[],"order":96,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"57855fd2a795200e00f149e0","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},"createdAt":"2016-07-12T21:23:30.708Z","parentDoc":null,"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},"user":"5613e4f8fdd08f2b00437620","__v":5,"githubsync":""}