{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/groups/","auth":"required","results":{"codes":[{"status":201,"language":"json","code":"{\n  \"description\": \"group for new witchers\",\n  \"id\": 6,\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/groups/6/\",\n    \"users\": \"/v1.1/instances/rivia/groups/6/users/\"\n  },\n  \"label\": \"new witchers\"\n}","name":""},{"language":"json","code":"{\n  \"name\": [\n    \"This field is required.\"\n  ]\n}","name":"","status":400},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"description\": \"group for new witchers\", \"label\": \"new witchers\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/groups/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import Group\n\nsyncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\nGroup.please.create(\n    label=\"My new group\"\n)\n","language":"python"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Group = connection.Group;\n\nvar options = {\n  label: \"GROUP_LABEL\", \n  description: \"GROUP_DESCRIPTION\",\n\tinstanceName: \"INSTANCE_NAME\"\n};\n\nGroup.please().create(options).then(callback);"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of an instance.","required":true,"in":"path","ref":"","_id":"552e30172594f70d001b2c7e"},{"name":"label","type":"string","default":"","desc":"Label of a group, can be max 64 characters.","required":true,"in":"body","ref":"","_id":"552ee429a702770d00d96f19"},{"name":"description","type":"string","default":"","desc":"Group description.","required":false,"in":"body","ref":"","_id":"558d4438beb7c719007f621a"}]},"next":{"description":"","pages":[]},"title":"Groups - add","type":"endpoint","slug":"groups-add","excerpt":"","body":"Adds a new Group to a given Instance.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"You need to provide a label for the Group and it needs to be unique across the Instance - e.g. you cannot have two groups labeled \\\"super_users\\\".\"\n}\n[/block]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50635bdcde80d004986da","__v":0,"createdAt":"2015-04-15T22:20:25.256Z","editedParams":true,"version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"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"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"editedParams2":true,"githubsync":"","project":"54774d9af3736008009e9e0e","category":{"sync":{"isSync":false,"url":""},"pages":["56c50635bdcde80d004986d8","56c50635bdcde80d004986d9","56c50635bdcde80d004986da","56c50635bdcde80d004986db","56c50635bdcde80d004986dc","56c50635bdcde80d004986dd","56c50635bdcde80d004986de","56c50635bdcde80d004986df","56c50635bdcde80d004986e0","56c50635bdcde80d004986e1"],"title":"Groups","slug":"groups","order":15,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498643","version":"56c50626bdcde80d00498635","createdAt":"2015-04-15T09:29:39.602Z","project":"54774d9af3736008009e9e0e","__v":1},"parentDoc":null,"user":"54774c47f3736008009e9e0c"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of an instance.

Body Params

label:
required
string
Label of a group, can be max 64 characters.
description:
string
Group description.

Examples


Result Format


Documentation

Adds a new Group to a given Instance. [block:callout] { "type": "info", "body": "You need to provide a label for the Group and it needs to be unique across the Instance - e.g. you cannot have two groups labeled \"super_users\"." } [/block]

User Information

Try It Out

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