{"_id":"5774f255ece8a00e00a15929","parentDoc":null,"__v":4,"project":"5773dcfc255e820e00e1cd4d","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"},"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"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-30T10:20:05.713Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":""},"isReference":false,"order":59,"body":"This call lists all the apps available to you.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/apps\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Public/private apps\",\n  \"body\": \"Note that you can see all of the publicly available apps on Cavatica by setting the query parameter `visibility` to `public`. If you omit this parameter, you will see all your `private` apps, i.e. those in projects that you can access. Learn more about [public apps](doc:public-apps) in our documentation.\"\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /v2/apps 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  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X GET \\\"https://cavatica-api.sbgenomics.com/v2/apps\\\" \",\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_required_\",\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###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    \"1-0\": \"`project`\",\n    \"2-0\": \"`project_owner`\",\n    \"3-0\": \"`visibility`\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"1-2\": \"Enter a project, in the form `{project_owner}/{project_short_name}` to restrict the results to apps from that project only.\",\n    \"2-2\": \"Enter a Cavatica username to restrict the results to apps from that user's projects only. Note that you can only see apps within projects that you are a member of.\",\n    \"3-2\": \"Set this to `public` to see all public apps on Cavatica.\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\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/apps/\\\",\\n  \\\"items\\\": [\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/workflow\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project/workflow\\\",\\n      \\\"name\\\": \\\"workflow\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/fusion-transcript-detection-chimerascan\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project/fusion-transcript-detection-chimerascan\\\",\\n      \\\"name\\\": \\\"fusion-transcript-detection-chimerascan\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/somaticsniper-filters\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project/somaticsniper-filters\\\",\\n      \\\"name\\\": \\\"somaticsniper-filters\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/command-line-tool\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project/command-line-tool\\\",\\n      \\\"name\\\": \\\"command-line-tool\\\"\\n    },\\n    {\\n      \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/delly2-workflow\\\",\\n      \\\"id\\\": \\\"RFranklin/my-project/delly2-workflow\\\",\\n      \\\"name\\\": \\\"delly2-workflow\\\"\\n    },\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","excerpt":"/apps\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"list-all-apps-available-to-you","type":"endpoint","title":"List all apps available to you"}

getList all apps available to you

/apps For general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).

This call lists all the apps available to you. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/apps", "language": "text", "name": "API path" } ] } [/block] [block:callout] { "type": "warning", "title": "Public/private apps", "body": "Note that you can see all of the publicly available apps on Cavatica by setting the query parameter `visibility` to `public`. If you omit this parameter, you will see all your `private` apps, i.e. those in projects that you can access. Learn more about [public apps](doc:public-apps) in our documentation." } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/apps HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\n", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"content-type: application/json\" -X GET \"https://cavatica-api.sbgenomics.com/v2/apps\" ", "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_required_", "0-1": "Your Cavatica [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.", "1-0": "`project`", "2-0": "`project_owner`", "3-0": "`visibility`", "1-1": "string", "2-1": "string", "3-1": "string", "1-2": "Enter a project, in the form `{project_owner}/{project_short_name}` to restrict the results to apps from that project only.", "2-2": "Enter a Cavatica username to restrict the results to apps from that user's projects only. Note that you can only see apps within projects that you are a member of.", "3-2": "Set this to `public` to see all public apps on Cavatica." }, "cols": 3, "rows": 4 } [/block] ##Response [See a list of Cavatica-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://cavatica-api.sbgenomics.com/v2/apps/\",\n \"items\": [\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/workflow\",\n \"id\": \"RFranklin/my-project/workflow\",\n \"name\": \"workflow\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/fusion-transcript-detection-chimerascan\",\n \"id\": \"RFranklin/my-project/fusion-transcript-detection-chimerascan\",\n \"name\": \"fusion-transcript-detection-chimerascan\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/somaticsniper-filters\",\n \"id\": \"RFranklin/my-project/somaticsniper-filters\",\n \"name\": \"somaticsniper-filters\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/command-line-tool\",\n \"id\": \"RFranklin/my-project/command-line-tool\",\n \"name\": \"command-line-tool\"\n },\n {\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/apps/RFranklin/my-project/delly2-workflow\",\n \"id\": \"RFranklin/my-project/delly2-workflow\",\n \"name\": \"delly2-workflow\"\n },\n ]\n}", "language": "json" } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>