{"_id":"56c50635bdcde80d004986d8","editedParams":true,"project":"54774d9af3736008009e9e0e","__v":0,"editedParams2":true,"parentDoc":null,"user":"54774c47f3736008009e9e0c","category":{"_id":"56c50628bdcde80d00498643","pages":["56c50635bdcde80d004986d8","56c50635bdcde80d004986d9","56c50635bdcde80d004986da","56c50635bdcde80d004986db","56c50635bdcde80d004986dc","56c50635bdcde80d004986dd","56c50635bdcde80d004986de","56c50635bdcde80d004986df","56c50635bdcde80d004986e0","56c50635bdcde80d004986e1"],"version":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":1,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-15T09:29:39.602Z","from_sync":false,"order":15,"slug":"groups","title":"Groups"},"githubsync":"","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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-15T09:31:04.930Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/groups/\""},{"language":"python","code":"import syncano\nfrom syncano.models import Group\n\nsyncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\nall_groups = Group.please.list()\n\nfor group in all_groups:\n    print(group.label)\n"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Group = connection.Group;\n\nGroup.please().list({instanceName: \"INSTANCE_NAME\"}).then(callback);"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"prev\": null,\n  \"objects\": [\n    {\n      \"description\": \"\",\n      \"id\": 1,\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/groups/1/\",\n        \"users\": \"/v1.1/instances/rivia/groups/1/users/\"\n      },\n      \"label\": \"witchers\"\n    },\n    {\n      \"description\": \"\",\n      \"id\": 2,\n      \"links\": {\n        \"self\": \"/v1.1/instances/rivia/groups/2/\",\n        \"users\": \"/v1.1/instances/rivia/groups/2/users/\"\n      },\n      \"label\": \"monsters\"\n    }\n  ],\n  \"next\": null\n}","name":"","status":200},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"552e30172594f70d001b2c7e","ref":"","in":"path","required":true,"desc":"Name of an instance.","default":"","type":"string","name":"instance_name"}],"url":"/instances/:instance_name/groups/"},"isReference":true,"order":0,"body":"Lists all the user Groups that belong to a given Instance.","excerpt":"","slug":"groups-list","type":"endpoint","title":"Groups - list"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of an instance.

Examples


Result Format


Documentation

Lists all the user Groups 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 }}