{"_id":"5b0e13ffc4664e0003c75b3f","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"},"__v":0,"parentDoc":null,"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"},"user":"554340dfb7f4540d00fcef1d","project":"5b0e13ffc4664e0003c75a66","githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":["566ed47795fe82170035ed6f","566f0436de4b662100d60dd4","56719172a0ee9b0d001852c0","56a5f6cdef5b2f0d00404206"],"next":{"pages":[],"description":""},"createdAt":"2015-10-29T20:41:18.167Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"post","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":15,"body":"This call creates a new project.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://f4c-api.sbgenomics.com/v2/projects\",\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\": \"POST /v2/projects HTTP/1.1\\nHost: f4c-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\ncontent-type: application/json\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"name\\\": \\\"My New Project\\\", \\\"description\\\": \\\"A project for testing my apps\\\", \\\"billing_group\\\": \\\"1f0c2751-694c-4e98-b863-06b68f5a61ca\\\", \\\"tags\\\": [\\\"tcga\\\"]}' -s -H \\\"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://f4c-api.sbgenomics.com/v2/projects\\\"\",\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\": \"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###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##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\": \"Datatype of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`name`\\n<span style=\\\"color:red\\\">_required_</span>\",\n    \"1-0\": \"`billing_group`\\n<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"2-0\": \"`description`\",\n    \"3-0\": \"`tags`\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string, enclosed in `'[ ]`\",\n    \"0-2\": \"The name of the project you are creating.\",\n    \"1-2\": \"The ID of the billing group for the project.\\n\\n[List all billing groups](doc:list-your-billing-groups) to find your billing group ID.\",\n    \"2-2\": \"A description of the project.\",\n    \"3-2\": \"Optionally, enter a tag if you want to make a [Controlled Data project](doc:projects-on-the-platform).\\n\\nIf you omit the `tags` key, the project will be an Open Data project.\",\n    \"4-0\": \"`settings`\",\n    \"4-1\": \"object\",\n    \"4-2\": \"This dictionary contains three fields, `locked`, `controlled` and `use_interruptible_instances` - see below for further information.\",\n    \"5-0\": \"<a name=\\\"lock\\\"></a>`locked`\",\n    \"5-1\": \"Boolean\",\n    \"5-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    \"6-0\": \"`controlled`\",\n    \"6-1\": \"Boolean\",\n    \"6-2\": \"Set to `true` to indicate a Controlled Data project. Learn more about [Controlled Data projects](doc:dbgap-controlled-data-access#section-data-access-levels).\",\n    \"7-0\": \"`use_interruptible_instances`\",\n    \"7-1\": \"Boolean\",\n    \"7-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\": 8\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n\\t\\\"name\\\": \\\"My New Project\\\", \\n  \\\"description\\\": \\\"A project for testing my apps\\\", \\n  \\\"billing_group\\\": \\\"1f0c2751-694c-4e98-b863-06b68f5a61ca\\\", \\n  \\\"tags\\\": [\\\"my-tag\\\"],\\n  \\\"settings\\\":{\\n    \\\"locked\\\": true,\\n     \\\"use_interruptible_instances\\\": false\\n    \\\"controlled\\\": true\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\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/my-new-project\\\",\\n  \\\"id\\\": \\\"RFranklin/my-new-project\\\",\\n  \\\"name\\\": \\\"My New Project\\\",\\n  \\\"type\\\": \\\"v2\\\",\\n  \\\"description\\\": \\\"A project for testing my apps\\\",\\n  \\\"tags\\\": [\\\"my-tag\\\"],\\n  \\\"settings\\\":{\\n    \\\"locked\\\": true,\\n    \\\"use_interruptible_instances\\\": false\\n    \\\"controlled\\\":true\\n  },\\n  \\\"billing_group\\\": \\\"1f0c2751-694c-4e98-b863-06b68f5a61ca\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n**Interpreting the response body**\n* The field `locked` is set to `true`, which means you've created a locked project.  Locking down a project prevents any Seven Bridges team member from viewing any information about the task.\n* The field `controlled` is set to `true`, which indicates you've created a Controlled Data project.","excerpt":"/projects","slug":"create-a-new-project","type":"endpoint","title":"Create a new project"}

postCreate a new project

/projects

This call creates a new project. [block:code] { "codes": [ { "code": "https://f4c-api.sbgenomics.com/v2/projects", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "POST /v2/projects HTTP/1.1\nHost: f4c-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\ncontent-type: application/json\n", "language": "http", "name": null }, { "code": "curl --data '{\"name\": \"My New Project\", \"description\": \"A project for testing my apps\", \"billing_group\": \"1f0c2751-694c-4e98-b863-06b68f5a61ca\", \"tags\": [\"tcga\"]}' -s -H \"X-SBG-Auth-Token: 7942f56901534434a054dafc3813bc96\" -H \"content-type: application/json\" -X POST \"https://f4c-api.sbgenomics.com/v2/projects\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/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] ###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] ##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": "Datatype of value", "h-2": "Description of value", "0-0": "`name`\n<span style=\"color:red\">_required_</span>", "1-0": "`billing_group`\n<span style=\"color:red\"><i>required</i></span>", "2-0": "`description`", "3-0": "`tags`", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "string, enclosed in `'[ ]`", "0-2": "The name of the project you are creating.", "1-2": "The ID of the billing group for the project.\n\n[List all billing groups](doc:list-your-billing-groups) to find your billing group ID.", "2-2": "A description of the project.", "3-2": "Optionally, enter a tag if you want to make a [Controlled Data project](doc:projects-on-the-platform).\n\nIf you omit the `tags` key, the project will be an Open Data project.", "4-0": "`settings`", "4-1": "object", "4-2": "This dictionary contains three fields, `locked`, `controlled` and `use_interruptible_instances` - see below for further information.", "5-0": "<a name=\"lock\"></a>`locked`", "5-1": "Boolean", "5-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.", "6-0": "`controlled`", "6-1": "Boolean", "6-2": "Set to `true` to indicate a Controlled Data project. Learn more about [Controlled Data projects](doc:dbgap-controlled-data-access#section-data-access-levels).", "7-0": "`use_interruptible_instances`", "7-1": "Boolean", "7-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": 8 } [/block] ###Example request body [block:code] { "codes": [ { "code": "{\n\t\"name\": \"My New Project\", \n \"description\": \"A project for testing my apps\", \n \"billing_group\": \"1f0c2751-694c-4e98-b863-06b68f5a61ca\", \n \"tags\": [\"my-tag\"],\n \"settings\":{\n \"locked\": true,\n \"use_interruptible_instances\": false\n \"controlled\": true\n }\n}", "language": "json" } ], "sidebar": true } [/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/my-new-project\",\n \"id\": \"RFranklin/my-new-project\",\n \"name\": \"My New Project\",\n \"type\": \"v2\",\n \"description\": \"A project for testing my apps\",\n \"tags\": [\"my-tag\"],\n \"settings\":{\n \"locked\": true,\n \"use_interruptible_instances\": false\n \"controlled\":true\n },\n \"billing_group\": \"1f0c2751-694c-4e98-b863-06b68f5a61ca\"\n}", "language": "json" } ], "sidebar": true } [/block] **Interpreting the response body** * The field `locked` is set to `true`, which means you've created a locked project. Locking down a project prevents any Seven Bridges team member from viewing any information about the task. * The field `controlled` is set to `true`, which indicates you've created a Controlled Data project.