{"_id":"5b0e13ffc4664e0003c75b84","parentDoc":null,"project":"5b0e13ffc4664e0003c75a66","user":"554340dfb7f4540d00fcef1d","category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"__v":0,"version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-06T14:54:52.367Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"patch","auth":"required","params":[],"url":""},"isReference":true,"order":19,"body":"This call edits the details of a project on the Platform. 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://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\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](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: f4c-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://f4c-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. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Changing a project's name\",\n  \"body\": \"Note that once the project has been created, [**you cannot change its short name**](the-api#section-project-short-names). However, you can edit a project's given name at any time using the call on this page.\"\n}\n[/block]\n\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    \"2-0\": \"`description`\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-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-your-billing-groups) to locate your billing group ID.\",\n    \"2-2\": \"A description of the project.\",\n    \"3-0\": \"`settings`\",\n    \"3-1\": \"dictionary\",\n    \"3-2\": \"This dictionary contains one field, `locked`.\",\n    \"4-0\": \"`locked`\",\n    \"4-1\": \"Boolean\",\n    \"4-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    \"5-0\": \"`use_interruptible_instances`\",\n    \"5-1\": \"Boolean\",\n    \"5-2\": \"This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances).\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Controlled Data project versus Open Data project\",\n  \"body\": \"Note that you can change a project's name, billing group, and description, but you can't change whether or not it is a Controlled Data project after the project has been created.\"\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\\\": true\\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 Platform [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](the-api#section-identifying-projects-users-apps-files-tasks-and-inputs) 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 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://f4c-api.sbgenomics.com/v2/projects/RFranklin/sandbox\\\",\\n  \\\"id\\\": \\\"RFranklin/sandbox\\\",\\n  \\\"name\\\": \\\"New name for my project\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"description\\\": \\\"Updated with the results of the latest experiments\\\",\\n  \\\"tags\\\": [],\\n  \\\"settings\\\": {\\n        \\\"locked\\\":true\\n        \\\"use_interruptible_instances\\\": false\\n    },\\n  \\\"billing_group\\\": \\\"eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"projects/{project_owner}/{project}","slug":"edit-a-specified-project","type":"endpoint","title":"Edit a project"}

patchEdit a project

projects/{project_owner}/{project}

This call edits the details of a project on the Platform. You can use it to change the name, description, or billing group of the project. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/projects/{project_owner}/{project}", "language": "text", "name": "Path" } ] } [/block] [block:callout] { "type": "success", "title": "Referring to your project", "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](the-api#section-identifying-projects-users-apps-files-tasks-and-inputs)." } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "PATCH /v2/projects/RFranklin/sandbox HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "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://f4c-api.sbgenomics.com/v2/projects/RFranklin/sandbox\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ##Request body The 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. [block:callout] { "type": "info", "title": "Changing a project's name", "body": "Note that once the project has been created, [**you cannot change its short name**](the-api#section-project-short-names). However, you can edit a project's given name at any time using the call on this page." } [/block] [block:parameters] { "data": { "h-0": "Key", "h-1": "Datatype of value", "h-2": "Description of value", "0-0": "`name`", "1-0": "`billing_group`", "2-0": "`description`", "0-1": "string", "1-1": "string", "2-1": "string", "0-2": "The name of the project you are editing.", "1-2": "The ID of the billing group for the project.\n\n[List all billing groups](doc:list-your-billing-groups) to locate your billing group ID.", "2-2": "A description of the project.", "3-0": "`settings`", "3-1": "dictionary", "3-2": "This dictionary contains one field, `locked`.", "4-0": "`locked`", "4-1": "Boolean", "4-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.", "5-0": "`use_interruptible_instances`", "5-1": "Boolean", "5-2": "This field can be true or false. Set this field to true to allow the use of [spot instances](doc:about-spot-instances)." }, "cols": 3, "rows": 6 } [/block] [block:callout] { "type": "success", "title": "Controlled Data project versus Open Data project", "body": "Note that you can change a project's name, billing group, and description, but you can't change whether or not it is a Controlled Data project after the project has been created." } [/block] ###Example request body [block:code] { "codes": [ { "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\": true\n\n }\n}", "language": "json" } ] } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n<span style=\"color:red\"><i>required</i></span>", "0-1": "Your Platform [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`project`", "1-0": "`project_owner`", "h-0": "Name", "h-1": "Description", "0-1": "The [short name](the-api#section-identifying-projects-users-apps-files-tasks-and-inputs) of the project you are editing.", "1-1": "The owner of the project you are editing." }, "cols": 2, "rows": 2 } [/block] ###Query parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Description", "0-0": "`fields`", "0-1": "string", "0-2": "Selector specifying a subset of fields to include in the response." }, "cols": 3, "rows": 1 } [/block] ##Response [See a list of specific response codes that may be contained in the body of the response.](doc:api-status-codes) ###Example response body [block:code] { "codes": [ { "code": "{\n \"href\": \"https://f4c-api.sbgenomics.com/v2/projects/RFranklin/sandbox\",\n \"id\": \"RFranklin/sandbox\",\n \"name\": \"New name for my project\",\n \"type\": \"v2\",\n \"description\": \"Updated with the results of the latest experiments\",\n \"tags\": [],\n \"settings\": {\n \"locked\":true\n \"use_interruptible_instances\": false\n },\n \"billing_group\": \"eb5fdee2-36c3-41d1-b179-d9f5d0a0f6f7\"\n}", "language": "json" } ] } [/block]