{"_id":"56c50629bdcde80d0049864d","project":"54774d9af3736008009e9e0e","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"},"category":{"_id":"56c50628bdcde80d00498637","__v":1,"project":"54774d9af3736008009e9e0e","pages":["56c50629bdcde80d0049864d","56c50629bdcde80d0049864e","56c50629bdcde80d0049864f","56c50629bdcde80d00498650","56c50629bdcde80d00498651","56c50629bdcde80d00498652","56c50629bdcde80d00498653"],"version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:17:03.866Z","from_sync":false,"order":1,"slug":"instances","title":"Instances"},"githubsync":"","parentDoc":null,"__v":6,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-01T11:11:10.731Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n\"https://api.syncano.io/v1.1/instances/\"","name":""},{"code":"import syncano \nfrom syncano.models import Instance \n\nconnection = syncano.connect(api_key='ACCOUNT_KEY')\n\nlist_of_instances = Instance.please.list()\n","language":"python"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Instance = connection.Instance;\n\nInstance.please().list().then(callback);"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"name\": \"rivia\",\n      \"links\": {\n        \"rename\": \"/v1.1/instances/rivia/rename/\",\n        \"endpoints\": \"/v1.1/instances/rivia/endpoints/\",\n        \"users\": \"/v1.1/instances/rivia/users/\",\n        \"triggers\": \"/v1.1/instances/rivia/triggers/\",\n        \"self\": \"/v1.1/instances/rivia/\",\n        \"batch\": \"/v1.1/instances/rivia/batch/\",\n        \"api_keys\": \"/v1.1/instances/rivia/api_keys/\",\n        \"channels\": \"/v1.1/instances/rivia/channels/\",\n        \"admins\": \"/v1.1/instances/rivia/admins/\",\n        \"classes\": \"/v1.1/instances/rivia/classes/\",\n        \"groups\": \"/v1.1/instances/rivia/groups/\",\n        \"schedules\": \"/v1.1/instances/rivia/schedules/\",\n        \"invitations\": \"/v1.1/instances/rivia/invitations/\",\n        \"push_notification\": \"/v1.1/instances/rivia/push_notifications/\",\n        \"snippets\": \"/v1.1/instances/rivia/snippets/\"\n      },\n      \"created_at\": \"2015-05-18T18:26:24.116191Z\",\n      \"updated_at\": \"2015-08-07T01:41:23.079259Z\",\n      \"role\": \"full\",\n      \"owner\": {\n        \"first_name\": \"Geralt\",\n        \"last_name\": \"\",\n        \"is_active\": true,\n        \"email\": \"geralt:::at:::from.rivia\",\n        \"has_password\": true,\n        \"id\": 8\n      },\n      \"metadata\": {\n        \"color\": \"brown\",\n        \"icon\": \"fire\"\n      },\n      \"description\": \"Wild Hunt\"\n    }\n  ],\n  \"next\": null\n}","language":"json","status":200},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[],"url":"/instances/"},"isReference":true,"order":0,"body":"A call to this endpoint allows you to get the list of all the instances that the given API Key has access to.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"- `account_key` will list all of your Instances\\n- `api_key` will list only an Instance that it belongs to.\"\n}\n[/block]","excerpt":"","slug":"instances-list","type":"endpoint","title":"Instance - list"}

getInstance - list


Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

A call to this endpoint allows you to get the list of all the instances that the given API Key has access to. [block:callout] { "type": "info", "body": "- `account_key` will list all of your Instances\n- `api_key` will list only an Instance that it belongs to." } [/block]

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 }}