{"_id":"5773e04f904b0c0e00ef0608","parentDoc":null,"githubsync":"","user":"575e85ac41c8ba0e00259a44","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"},"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"},"__v":22,"project":"5773dcfc255e820e00e1cd4d","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-29T14:50:55.952Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"This call returns all API paths, so that you don't need to rely on documentation in the terminal.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/\",\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\": \"GET /v2/ 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/\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Listing API calls\",\n  \"body\": \"This is the only call that does not require your authentication token.\"\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  \\\"rate_limit_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/rate_limit\\\",\\n  \\\"user_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/user\\\",\\n  \\\"users_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/users\\\",\\n  \\\"billing_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/billing\\\",\\n  \\\"projects_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects\\\",\\n  \\\"files_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/files\\\",\\n  \\\"tasks_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/tasks\\\",\\n  \\\"apps_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/apps\\\",\\n  \\\"action_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/action\\\",\\n  \\\"upload_url\\\":\\\"https://cavatica-api.sbgenomics.com/v2/upload\\\",\\n  \\\"storage_url\\\": \\\"https://cavatica-api.sbgenomics.com/v2/storage\\\"\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": null\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div> \n\n<hr>","excerpt":"/\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","slug":"list-of-api-calls","type":"endpoint","title":"List all API paths"}

getList all API paths

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

This call returns all API paths, so that you don't need to rely on documentation in the terminal. [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/", "language": "text", "name": "API path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /v2/ 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/", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] [block:callout] { "type": "success", "title": "Listing API calls", "body": "This is the only call that does not require your authentication token." } [/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 \"rate_limit_url\": \"https://cavatica-api.sbgenomics.com/v2/rate_limit\",\n \"user_url\": \"https://cavatica-api.sbgenomics.com/v2/user\",\n \"users_url\": \"https://cavatica-api.sbgenomics.com/v2/users\",\n \"billing_url\": \"https://cavatica-api.sbgenomics.com/v2/billing\",\n \"projects_url\": \"https://cavatica-api.sbgenomics.com/v2/projects\",\n \"files_url\": \"https://cavatica-api.sbgenomics.com/v2/files\",\n \"tasks_url\": \"https://cavatica-api.sbgenomics.com/v2/tasks\",\n \"apps_url\": \"https://cavatica-api.sbgenomics.com/v2/apps\",\n \"action_url\": \"https://cavatica-api.sbgenomics.com/v2/action\",\n \"upload_url\":\"https://cavatica-api.sbgenomics.com/v2/upload\",\n \"storage_url\": \"https://cavatica-api.sbgenomics.com/v2/storage\"\n}\n", "language": "json", "name": null } ], "sidebar": true } [/block] <div align="right"><a href="#top">top</a></div> <hr>