{"_id":"5790a5f1affd0429005feda1","parentDoc":null,"project":"5773dcfc255e820e00e1cd4d","githubsync":"","__v":1,"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":"575e85ac41c8ba0e00259a44","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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-21T10:37:37.944Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":92,"body":"This call lets you queue a job to export a file from a project on Cavatica into a volume.\n\nEssentially, the call writes to your cloud storage bucket on Amazon Web Services via the volume.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on Cavatica.\\n\\nThe volume you are exporting to must be configured for read-write access. To do this, set the `access_mode` parameter to `RW` when [creating](doc:create-a-volume-v2) or \\n[modifying](doc:update-a-volume-v2) a volume.\\n\\nPlease note that export from Cavatica to Google Cloud Storage volumes is currently not supported.\",\n  \"title\": \"Prerequisite\"\n}\n[/block]\n\nIf this call is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the Platform and, if no more copies of this file exist, it will no longer count towards your total storage price on the Platform.\n\nLearn more about using the Volumes API for [Amazon S3](http://docs.sevenbridges.com/docs/aws-cloud-storage-tutorial) and for [Google Cloud Storage](http://docs.sevenbridges.com/docs/google-cloud-storage-tutorial).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/storage/exports\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/storage/exports HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\nContent-Type: application/json\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data ':::at:::export.json' -X POST -H \\\"X-SBG-Auth-Token: ce7ae5ab85e946599298e88a3430fba0\\\" -H \\\"Content-Type: application/json\\\" 'https://cavatica-api.sbgenomics.com/v2/storage/exports'\",\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 Cavatica [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###Request body\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    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`source`\\n_required_\",\n    \"0-1\": \"Object\",\n    \"1-0\": \"`file`\\n_required_\",\n    \"1-1\": \"String\",\n    \"1-2\": \"The ID of the file for export.\",\n    \"2-0\": \"`destination`\\n_required_\",\n    \"2-1\": \"Object\",\n    \"3-0\": \"`volume`\\n_required_\",\n    \"3-1\": \"String\",\n    \"3-2\": \"The ID of the volume to which the file will be exported.\",\n    \"4-0\": \"`location`\\n_required_\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Volume-specific location to which the file will be exported. This location should be recognizable to the underlying cloud service as a valid key or path to a new file.\\n\\nPlease note that if this volume has been configured with a `prefix` parameter, the value of `prefix` will be prepended to `location` before attempting to create the file on the volume.\",\n    \"5-0\": \"`properties`\",\n    \"5-1\": \"Object\",\n    \"5-2\": \"Service-specific properties of the export.\\n\\nThese values override the defaults from the volume.\",\n    \"6-0\": \"`sse_algorithm`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"S3 server-side encryption to use when exporting to this bucket.\\n\\nSupported values:\\n  * `AES256` (SSE-S3 encryption);\\n  * null (no server-side encryption).\\n\\n_default: `AES256`_\",\n    \"7-0\": \"`aws_canned_acl`\",\n    \"7-1\": \"String\",\n    \"7-2\": \"S3 canned ACL to apply on the object on during export.\\n\\nSupported values:\\n  * any one of [S3 canned ACLs](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl);\\n  * `null` (do not apply canned ACLs).\\n\\n_default: `null`_\",\n    \"0-2\": \"This object should describe the source from which the file should be exported.\",\n    \"2-2\": \"This object should describe the destination to which the file will be exported.\",\n    \"8-0\": \"`overwrite`\",\n    \"8-1\": \"Boolean\",\n    \"8-2\": \"If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\\n\\n_default_: `false`\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\t\\\"source\\\": {\\n  \\t\\t\\\"file\\\": \\\"52d69fc0e4b0a77ec4fd206c\\\"\\n  \\t},\\n  \\t\\\"destination\\\": {\\n  \\t\\t\\\"volume\\\": \\\"rfranklin/output\\\",\\n  \\t\\t\\\"location\\\": \\\"output.vcf\\\"\\n  \\t}\\n  } \\n\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response](doc:api-status-codes).\n\n###Response body\n\nThe response object contains information about the status of the export job. The information is structured using the following key-value pairs:\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\": \"`id`\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"1-0\": \"`state`\",\n    \"2-0\": \"`source`\",\n    \"2-1\": \"Object\",\n    \"3-0\": \"`destination`\",\n    \"3-1\": \"Object\",\n    \"4-0\": \"`result`\",\n    \"4-1\": \"Object\",\n    \"5-0\": \"`error`\",\n    \"5-1\": \"Object\",\n    \"0-2\": \"ID of this export job\",\n    \"1-2\": \"The state of this export job. Possible values are:\\n  * `PENDING`: the export is queued\\n  * `RUNNING`: the export is running\\n  * `COMPLETED`: the export has completed successfully\\n  * `FAILED`: the export has failed\",\n    \"2-2\": \"Export source, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).\",\n    \"3-2\": \"Export destination, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).\",\n    \"4-2\": \"File object that was [exported](get-file-details).\",\n    \"5-2\": \"In case of error in the export job, standard API error is returned here.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n  \\\"id\\\": \\\"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\\\",\\n  \\\"state\\\": \\\"PENDING\\\",\\n  \\\"source\\\": {\\n    \\\"file\\\": \\\"576159f7f5b4e1de6ae9b5f0\\\"\\n  },\\n  \\\"destination\\\": {\\n    \\\"volume\\\": \\\"rfranklin/output\\\",\\n    \\\"location\\\": \\\"output.vcf\\\"\\n  },\\n  \\\"started_on\\\": \\\"2016-06-15T19:17:39Z\\\",\\n  \\\"properties\\\": {\\n    \\\"sse_algorithm\\\": \\\"AES256\\\",\\n    \\\"aws_canned_acl\\\": \\\"public-read\\\"\\n  },\\n  \\\"overwrite\\\": false\\n}\",\n      \"language\": \"json\",\n      \"name\": \"\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"start-an-export-job-v2","type":"endpoint","title":"Start an export job"}

postStart an export job


This call lets you queue a job to export a file from a project on Cavatica into a volume. Essentially, the call writes to your cloud storage bucket on Amazon Web Services via the volume. [block:callout] { "type": "info", "body": "The file selected for export must not be a public file or an alias. Aliases are objects stored in your cloud storage bucket which have been made available on Cavatica.\n\nThe volume you are exporting to must be configured for read-write access. To do this, set the `access_mode` parameter to `RW` when [creating](doc:create-a-volume-v2) or \n[modifying](doc:update-a-volume-v2) a volume.\n\nPlease note that export from Cavatica to Google Cloud Storage volumes is currently not supported.", "title": "Prerequisite" } [/block] If this call is successful, the original project file will become an alias to the newly exported object on the volume. The source file will be deleted from the Platform and, if no more copies of this file exist, it will no longer count towards your total storage price on the Platform. Learn more about using the Volumes API for [Amazon S3](http://docs.sevenbridges.com/docs/aws-cloud-storage-tutorial) and for [Google Cloud Storage](http://docs.sevenbridges.com/docs/google-cloud-storage-tutorial). [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/storage/exports", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/storage/exports HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\nContent-Type: application/json", "language": "http", "name": null }, { "code": "curl --data '@export.json' -X POST -H \"X-SBG-Auth-Token: ce7ae5ab85e946599298e88a3430fba0\" -H \"Content-Type: application/json\" 'https://cavatica-api.sbgenomics.com/v2/storage/exports'", "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 Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Request body In the body, you should enter a list of key-value pairs. The keys, and the values they take, are described in the following table. [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`source`\n_required_", "0-1": "Object", "1-0": "`file`\n_required_", "1-1": "String", "1-2": "The ID of the file for export.", "2-0": "`destination`\n_required_", "2-1": "Object", "3-0": "`volume`\n_required_", "3-1": "String", "3-2": "The ID of the volume to which the file will be exported.", "4-0": "`location`\n_required_", "4-1": "String", "4-2": "Volume-specific location to which the file will be exported. This location should be recognizable to the underlying cloud service as a valid key or path to a new file.\n\nPlease note that if this volume has been configured with a `prefix` parameter, the value of `prefix` will be prepended to `location` before attempting to create the file on the volume.", "5-0": "`properties`", "5-1": "Object", "5-2": "Service-specific properties of the export.\n\nThese values override the defaults from the volume.", "6-0": "`sse_algorithm`", "6-1": "String", "6-2": "S3 server-side encryption to use when exporting to this bucket.\n\nSupported values:\n * `AES256` (SSE-S3 encryption);\n * null (no server-side encryption).\n\n_default: `AES256`_", "7-0": "`aws_canned_acl`", "7-1": "String", "7-2": "S3 canned ACL to apply on the object on during export.\n\nSupported values:\n * any one of [S3 canned ACLs](http://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl);\n * `null` (do not apply canned ACLs).\n\n_default: `null`_", "0-2": "This object should describe the source from which the file should be exported.", "2-2": "This object should describe the destination to which the file will be exported.", "8-0": "`overwrite`", "8-1": "Boolean", "8-2": "If true and a file exists in the given location on the volume (respecting volume prefix if given), the API will attempt to delete the existing file on the volume before exporting.\n\n_default_: `false`" }, "cols": 3, "rows": 9 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n \t\"source\": {\n \t\t\"file\": \"52d69fc0e4b0a77ec4fd206c\"\n \t},\n \t\"destination\": {\n \t\t\"volume\": \"rfranklin/output\",\n \t\t\"location\": \"output.vcf\"\n \t}\n } \n", "language": "text" } ] } [/block] ##Response [See a list of Cavatica-specific response codes that may be contained in the body of the response](doc:api-status-codes). ###Response body The response object contains information about the status of the export job. The information is structured using the following key-value pairs: [block:parameters] { "data": { "h-0": "Key", "h-1": "Data type of value", "h-2": "Description of value", "0-0": "`id`", "0-1": "String", "1-1": "String", "1-0": "`state`", "2-0": "`source`", "2-1": "Object", "3-0": "`destination`", "3-1": "Object", "4-0": "`result`", "4-1": "Object", "5-0": "`error`", "5-1": "Object", "0-2": "ID of this export job", "1-2": "The state of this export job. Possible values are:\n * `PENDING`: the export is queued\n * `RUNNING`: the export is running\n * `COMPLETED`: the export has completed successfully\n * `FAILED`: the export has failed", "2-2": "Export source, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).", "3-2": "Export destination, as passed when this job was started by the call to [Start an export job](doc:start-an-export-job-v2).", "4-2": "File object that was [exported](get-file-details).", "5-2": "In case of error in the export job, standard API error is returned here." }, "cols": 3, "rows": 6 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/storage/exports/2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"id\": \"2fzgXdc7zqeYFMiVvTCZdLBKgUpKdUhn\",\n \"state\": \"PENDING\",\n \"source\": {\n \"file\": \"576159f7f5b4e1de6ae9b5f0\"\n },\n \"destination\": {\n \"volume\": \"rfranklin/output\",\n \"location\": \"output.vcf\"\n },\n \"started_on\": \"2016-06-15T19:17:39Z\",\n \"properties\": {\n \"sse_algorithm\": \"AES256\",\n \"aws_canned_acl\": \"public-read\"\n },\n \"overwrite\": false\n}", "language": "json", "name": "" } ], "sidebar": true } [/block]