{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","examples":{"codes":[]},"method":"patch","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Edit a project","type":"endpoint","slug":"edit-a-project","excerpt":"projects/{project_owner}/{project}\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call edits a project on Cavatica. You can use it to change the name, description, or billing group of the project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"PATCH\",\n  \"body\": \"If your client does not support `PATCH` requests, you can use `POST` to send this request, along with the query parameter `_method=PATCH`:\\n\\ni.e. `https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}?_method=PATCH`\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Referring to your project\",\n  \"body\": \"Note that `project_owner` is always case-sensitive, and that `project` is not the project's name but its ID, or short name. For full details of identifying objects using the API, please see the [API overview](doc:the-api#section-identifying-projects-users-apps-files-tasks-and-inputs).\"\n}\n[/block]\n ##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"PATCH /v2/projects/RFranklin/sandbox HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  --data '{\\\"name\\\": \\\"New name for my project\\\", \\\"description\\\": \\\"Updated with the results of the latest experiments\\\"}' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X PATCH \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/sandbox\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n##Request body\nThe request body should contain a set of key-value pairs. The keys, and the values they take, are described in the following table. Enter a key-value pair if you want to re-set the existing value for the project. Note that although you may change the name of the project, this does not affect its [short name](doc:the-api#section-project-short-names), which is immutable.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Datatype of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`name`\",\n    \"1-0\": \"`billing_group`\",\n    \"4-0\": \"`description`\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"4-1\": \"string\",\n    \"0-2\": \"The name of the project you are editing.\",\n    \"1-2\": \"The ID of the billing group for the project.\\n\\n[List all billing groups](doc:list-billing-groups)  to find your billing group ID.\",\n    \"4-2\": \"A description of the project.\",\n    \"5-0\": \"`settings`\",\n    \"5-1\": \"dictionary\",\n    \"5-2\": \"This dictionary contains one field, `locked`.\",\n    \"6-0\": \"`locked`\",\n    \"6-1\": \"Boolean\",\n    \"6-2\": \"This field can be `true` or `false`.\\n\\nSet this field to `true` to lock down a project. Locking down a project prevents any Seven Bridges team member from viewing any information about the task.\",\n    \"7-0\": \"`use_interruptible_instances`\",\n    \"7-1\": \"Boolean\",\n    \"7-2\": \"This field can be `true` or `false` to enable or disable the use of [spot instances](doc:about-spot-instances).\",\n    \"2-0\": \"`use_memoization`\",\n    \"2-1\": \"boolean\",\n    \"2-2\": \"Set to `false` by default. Set to `true` to enable [memoization](doc:about-memoization).\",\n    \"3-0\": \"`intermediate_files`\",\n    \"3-1\": \"dictionary\",\n    \"3-2\": \"Specifies [intermediate files](doc:about-memoization#section-intermediate-files)retention period.\\n\\nTo do this, specify a dictionary with the following format:\\n```\\n{ \\\"retention\\\": \\\"LIMITED\\\", \\n   \\\"duration\\\": 24 }\\n```\\nThe minimum value is 1 h. The maximum value is 120 h and the default value is 24 h.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"name\\\": \\\"New name for my project\\\",\\n    \\\"description\\\": \\\"Updated with the results of the latest experiments\\\",\\n  \\t\\\"settings\\\": {\\n        \\\"locked\\\":true,\\n        \\\"use_interruptible_instances\\\":false,\\n        \\\"use_memoization\\\": true,\\n        \\\"intermediate_files\\\": {\\n            \\\"retention\\\":\\\"LIMITED\\\",\\n            \\\"duration\\\":24\\n        }\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`project`\",\n    \"1-0\": \"`project_owner`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The [short name](doc:the-api#section-project-short-names) of the project you are editing.\",\n    \"1-1\": \"The owner of the project you are editing.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\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]\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###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-new-project\\\",\\n  \\\"id\\\": \\\"RFranklin/my-new-project\\\",\\n  \\\"name\\\": \\\"My New Project\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"tags\\\": [],\\n  \\\"description\\\": \\\"A project for testing my apps\\\",\\n  \\\"settings\\\": {\\n    \\\"locked\\\": true,\\n    \\\"use_interruptible_instances\\\": false,\\n    \\\"use_memoization\\\": true,\\n    \\\"intermediate_files\\\": {\\n      \\\"retention\\\":\\\"LIMITED\\\",\\n      \\\"duration\\\":24\\n     }\\n  },\\n  \\\"billing_group\\\": \\\"1f0c2751-694c-4e98-b863-06b68f5a61ca\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","updates":[],"order":22,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5773f4188029ad0e00c38f22","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"createdAt":"2016-06-29T16:15:20.269Z","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"__v":5,"githubsync":"","parentDoc":null,"user":"575e85ac41c8ba0e00259a44"}