{"_id":"56c50629bdcde80d00498650","parentDoc":null,"project":"54774d9af3736008009e9e0e","editedParams":true,"editedParams2":true,"githubsync":"","user":"54774c47f3736008009e9e0c","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"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-10T13:36:14.770Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"put","results":{"codes":[{"language":"json","code":"{\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\": \"2016-03-10T18:21:20.629673Z\",\n  \"role\": \"full\",\n  \"owner\": {\n    \"first_name\": \"\",\n    \"last_name\": \"\",\n    \"is_active\": true,\n    \"email\": \":::at:::\",\n    \"has_password\": true,\n    \"id\": 8\n  },\n  \"metadata\": {\n    \"color\": \"#654321\"\n  },\n  \"description\": \"My new updated description\"\n}","name":"","status":200},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X PUT \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"description\":\"My new updated description\",\n     \"metadata\":{\"color\":\"#654321\"}}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/\"","name":""},{"language":"python","code":"import syncano \nfrom syncano.models import Instance\n\nconnection = syncano.connect(api_key=\"ACCOUNT_KEY\", name=\"INSTANCE_NAME\")\n\nInstance.please.update(\n    data={\n    \t\t\"description\": \"new description of the instance\"\n  \t}\n)"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Instance = connection.Instance;\n\nvar query = {\"name\":\"example_name\"};\nvar update = {\n  \"description\":\"new description of the instance\",\n  \"metadata\":{\"color\":\"#654321\"}\n};\n\nInstance.please().update(query, update).then(callback);"}]},"auth":"required","params":[{"_id":"547c4ee9deb8310800db015e","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"54da094e17df210d00be1cec","ref":"","in":"body","required":false,"desc":"Instance description","default":"","type":"string","name":"description"},{"_id":"54da094e17df210d00be1ceb","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/:instance_name/"},"isReference":true,"order":3,"body":"With the use of this method, you can modify the Instance description and metadata.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Important!\",\n  \"body\": \"Instances don't have ids and Instance name is what is used as an identification method. That's why the name is unique and cannot be changed with PUT and PATCH API Calls after an Instance is created.\"\n}\n[/block]\nWhen using PUT, the default values will be used for parameters you do not pass. If there are no default values, old values will be preserved","excerpt":"","slug":"instance-update-put","type":"endpoint","title":"Instance - update"}

putInstance - update


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

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

With the use of this method, you can modify the Instance description and metadata. [block:callout] { "type": "warning", "title": "Important!", "body": "Instances don't have ids and Instance name is what is used as an identification method. That's why the name is unique and cannot be changed with PUT and PATCH API Calls after an Instance is created." } [/block] When using PUT, the default values will be used for parameters you do not pass. If there are no default values, old values will be preserved

User Information

Try It Out

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