{"_id":"56c5062cbdcde80d00498670","__v":1,"project":"54774d9af3736008009e9e0e","parentDoc":null,"user":"54774c47f3736008009e9e0c","version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"githubsync":"","category":{"_id":"56c50628bdcde80d00498636","__v":1,"pages":["56c5062cbdcde80d0049866f","56c5062cbdcde80d00498670","56c5062cbdcde80d00498671","56c5062cbdcde80d00498672","56c5062cbdcde80d00498673","56c5062cbdcde80d00498674"],"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2014-12-01T11:06:30.128Z","from_sync":false,"order":0,"slug":"general-info","title":"General Info"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-25T10:33:50.260Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"WARNING!\",\n  \"body\": \"If you decide to use the API Explorer's (\\\"Try it\\\") functionality, you'll be making requests to your own Instances. Use with caution!\"\n}\n[/block]\nYou can use the API Explorer functionality to find out how different API methods work. In order to do that click the \"Key\" icon that can be found in the \"Try it out\" section of any of the documented methods:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/o28H3m5jShCge6ZJokOr_Instance_-_list_·_Syncano_Documentation.jpg\",\n        \"Instance_-_list_·_Syncano_Documentation.jpg\",\n        \"1512\",\n        \"316\",\n        \"#5db657\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nNext, paste your API Key (learn how to get the API Key [here](../../docs/authentication)) in the dialog box and click the \"tick\" icon:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/GIES7uiAT1GGmBtBSqZL_Instance_-_list_·_Syncano_Documentation.jpg\",\n        \"Instance_-_list_·_Syncano_Documentation.jpg\",\n        \"1516\",\n        \"656\",\n        \"#f4336f\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nGreat! Now whenever you press \"Try it!\" button, you'll be able make real requests to your own Instance.","excerpt":"","slug":"api-explorer-usage","type":"basic","title":"API Explorer Usage"}

API Explorer Usage


[block:callout] { "type": "danger", "title": "WARNING!", "body": "If you decide to use the API Explorer's (\"Try it\") functionality, you'll be making requests to your own Instances. Use with caution!" } [/block] You can use the API Explorer functionality to find out how different API methods work. In order to do that click the "Key" icon that can be found in the "Try it out" section of any of the documented methods: [block:image] { "images": [ { "image": [ "https://files.readme.io/o28H3m5jShCge6ZJokOr_Instance_-_list_·_Syncano_Documentation.jpg", "Instance_-_list_·_Syncano_Documentation.jpg", "1512", "316", "#5db657", "" ] } ] } [/block] Next, paste your API Key (learn how to get the API Key [here](../../docs/authentication)) in the dialog box and click the "tick" icon: [block:image] { "images": [ { "image": [ "https://files.readme.io/GIES7uiAT1GGmBtBSqZL_Instance_-_list_·_Syncano_Documentation.jpg", "Instance_-_list_·_Syncano_Documentation.jpg", "1516", "656", "#f4336f", "" ] } ] } [/block] Great! Now whenever you press "Try it!" button, you'll be able make real requests to your own Instance.