{"_id":"56c50629bdcde80d0049864f","project":"54774d9af3736008009e9e0e","__v":0,"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"},"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"},"editedParams":true,"editedParams2":true,"parentDoc":null,"user":"54774c47f3736008009e9e0c","githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-12-01T11:16:33.575Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"code":"curl -X POST \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"name\":\"new-instance\",\n     \"description\":\"description\"}' \\\n\"https://api.syncano.io/v1.1/instances/\"","language":"curl","name":""},{"code":"import syncano \nfrom syncano.models import Instance\n\nconnection = syncano.connect(api_key=\"ACCOUNT_KEY\", name=\"INSTANCE_NAME\")\n\nInstance.please.create(\n    name=\"example_name\",\n    description=\"description of my instance\", \n    metadata={\"color\":\"#000099\"}\n)","language":"python"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Instance = connection.Instance;\n\nvar instance = {\n  \"name\":\"example_name\",\n  \"description\":\"description of my instance\",\n  \"metadata\":{\"color\":\"#123456\"}\n};\n\nInstance.please().create(instance).then(callback);"}]},"method":"post","results":{"codes":[{"name":"","code":"{\n  \"name\": \"new-instance\",\n  \"links\": {\n    \"rename\": \"/v1.1/instances/new-instance/rename/\",\n    \"endpoints\": \"/v1.1/instances/new-instance/endpoints/\",\n    \"users\": \"/v1.1/instances/new-instance/users/\",\n    \"triggers\": \"/v1.1/instances/new-instance/triggers/\",\n    \"self\": \"/v1.1/instances/new-instance/\",\n    \"batch\": \"/v1.1/instances/new-instance/batch/\",\n    \"api_keys\": \"/v1.1/instances/new-instance/api_keys/\",\n    \"channels\": \"/v1.1/instances/new-instance/channels/\",\n    \"admins\": \"/v1.1/instances/new-instance/admins/\",\n    \"classes\": \"/v1.1/instances/new-instance/classes/\",\n    \"groups\": \"/v1.1/instances/new-instance/groups/\",\n    \"schedules\": \"/v1.1/instances/new-instance/schedules/\",\n    \"invitations\": \"/v1.1/instances/new-instance/invitations/\",\n    \"push_notification\": \"/v1.1/instances/new-instance/push_notifications/\",\n    \"snippets\": \"/v1.1/instances/new-instance/snippets/\"\n  },\n  \"created_at\": \"2016-03-10T18:16:34.652902Z\",\n  \"updated_at\": \"2016-03-10T18:16:34.657057Z\",\n  \"role\": \"api_key\",\n  \"owner\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\",\n    \"is_active\": true,\n    \"email\": \"\",\n    \"has_password\": true,\n    \"id\": 8\n  },\n  \"metadata\": {},\n  \"description\": \"description\"\n}","language":"json","status":201},{"name":"","code":"{\n  \"name\": [\n    \"Instance with this Name already exists.\"\n  ]\n}","language":"json","status":400},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"}]},"auth":"required","params":[{"_id":"547c4ee9deb8310800db015e","ref":"","in":"body","required":true,"desc":"Instance name","default":"","type":"string","name":"name"},{"_id":"547c4ee9deb8310800db015d","ref":"","in":"body","required":false,"desc":"Instance description","default":"","type":"string","name":"description"},{"_id":"555687b92f6b480d0034d99a","ref":"","in":"body","required":false,"desc":"Instance metadata. `icon` and `color` properties are used in Syncano Dashboard for Instance looks customisation. You can add your own properties too.","default":"","type":"object","name":"metadata"}],"url":"/instances/"},"isReference":true,"order":2,"body":"Creates an instance with a given name, description and metadata. Metadata is passed as a JSON dictionary.","excerpt":"","slug":"instances-add","type":"endpoint","title":"Instance - add"}

postInstance - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

name:
required
string
Instance name
description:
string
Instance description
metadata:
object
Instance metadata. `icon` and `color` properties are used in Syncano Dashboard for Instance looks customisation. You can add your own properties too.

Examples


Result Format


Documentation

Creates an instance with a given name, description and metadata. Metadata is passed as a JSON dictionary.

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