{"_id":"56c50633bdcde80d004986b7","editedParams":true,"editedParams2":true,"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"},"category":{"_id":"56c50628bdcde80d00498645","version":"56c50626bdcde80d00498635","__v":1,"project":"54774d9af3736008009e9e0e","pages":["56c50633bdcde80d004986b7","56c50633bdcde80d004986b8","56c50633bdcde80d004986b9","56c50633bdcde80d004986ba","56c50633bdcde80d004986bb","56c50633bdcde80d004986bc","56c50633bdcde80d004986bd","56c50633bdcde80d004986be","56c50633bdcde80d004986bf"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-05-21T13:12:14.654Z","from_sync":false,"order":19,"slug":"channels","title":"Channels"},"parentDoc":null,"user":"54774c47f3736008009e9e0c","githubsync":"","project":"54774d9af3736008009e9e0e","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-05-21T13:34:51.719Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"gist":"47d76024a9729f415058","language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"X-USER-KEY: USER_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/<instance>/channels/\"","name":""},{"language":"python","code":"import syncano\nfrom syncano.models import Channel\n\nsyncano.connect(api_key=\"API_KEY\", user_key=\"USER_KEY\", instance_name=\"INSTANCE_NAME\")\n\nchannels = Channel.please.list()\n\nfor c in channels:\n    print(c.name)\n  "},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\", userKey: \"USER_KEY\"});\nvar Channel = connection.Channel;\n\nChannel.please().list({instanceName: \"INSTANCE_NAME\"}).then(callback);","language":"javascript"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"group\": null,\n      \"name\": \"passiflora\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/channels/passiflora/\",\n        \"poll\": \"/v1.1/instances/rivia/channels/passiflora/poll/\",\n        \"publish\": \"/v1.1/instances/rivia/channels/passiflora/publish/\",\n        \"history\": \"/v1.1/instances/rivia/channels/passiflora/history/\"\n      },\n      \"group_permissions\": \"none\",\n      \"other_permissions\": \"publish\",\n      \"updated_at\": \"2015-05-22T16:17:18.337726Z\",\n      \"custom_publish\": true,\n      \"type\": \"default\",\n      \"created_at\": \"2015-05-22T16:17:18.337682Z\",\n      \"description\": \"\"\n    },\n    {\n      \"group\": null,\n      \"name\": \"witchers\",\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/channels/witchers/\",\n        \"poll\": \"/v1.1/instances/rivia/channels/witchers/poll/\",\n        \"publish\": \"/v1.1/instances/rivia/channels/witchers/publish/\",\n        \"history\": \"/v1.1/instances/rivia/channels/witchers/history/\"\n      },\n      \"group_permissions\": \"none\",\n      \"other_permissions\": \"subscribe\",\n      \"updated_at\": \"2015-08-19T22:39:02.163481Z\",\n      \"custom_publish\": false,\n      \"type\": \"separate_rooms\",\n      \"created_at\": \"2015-08-19T20:45:20.216634Z\",\n      \"description\": \"\"\n    }\n  ],\n  \"next\": null\n}","name":""},{"status":403,"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json"},{"language":"json","status":404,"code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"555ddf718ab3180d001ac55f","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"}],"url":"/instances/:instance_name/channels/"},"isReference":true,"order":0,"body":"Calling this endpoint allows you to get the list of all Channels that belong to a given Instance.","excerpt":"","slug":"channels-list","type":"endpoint","title":"Channels - list"}

getChannels - list


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Examples


Result Format


Documentation

Calling this endpoint allows you to get the list of all Channels that belong to a given Instance.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}