{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/rename/","auth":"required","examples":{"codes":[{"code":"curl -X POST \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"new_name\": \"NEW_NAME\"}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/rename/\"","language":"curl"},{"language":"python","code":"import syncano\nfrom syncano.models import Instance\n\nconnection = syncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\ninstance = Instance.please.get()\ninstance.rename(new_name=\"NEW_INSTANCE_NAME\")\n\nconnection = syncano.connect(api_key=\"API_KEY\", instance_name=\"NEW_INSTANCE_NAME\")\n"},{"language":"javascript","code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Instance = connection.Instance;\n\nInstance.please().rename({name: \"example_name\"}, {new_name: \"not_example\"}).then(callback);"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance Name","required":true,"in":"path","ref":"","_id":"569e95efebbadc0d0079bf25"},{"name":"new_name","type":"string","default":"","desc":"New Name for Instance","required":false,"in":"body","ref":"","_id":"569e9a336b4a2c0d007e915b"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"name\": \"new-rivia\",\n  \"links\": {\n    \"rename\": \"/v1.1/instances/new-rivia/rename/\",\n    \"endpoints\": \"/v1.1/instances/new-rivia/endpoints/\",\n    \"users\": \"/v1.1/instances/new-rivia/users/\",\n    \"triggers\": \"/v1.1/instances/new-rivia/triggers/\",\n    \"self\": \"/v1.1/instances/new-rivia/\",\n    \"batch\": \"/v1.1/instances/new-rivia/batch/\",\n    \"api_keys\": \"/v1.1/instances/new-rivia/api_keys/\",\n    \"channels\": \"/v1.1/instances/new-rivia/channels/\",\n    \"admins\": \"/v1.1/instances/new-rivia/admins/\",\n    \"classes\": \"/v1.1/instances/new-rivia/classes/\",\n    \"groups\": \"/v1.1/instances/new-rivia/groups/\",\n    \"schedules\": \"/v1.1/instances/new-rivia/schedules/\",\n    \"invitations\": \"/v1.1/instances/new-rivia/invitations/\",\n    \"push_notification\": \"/v1.1/instances/new-rivia/push_notifications/\",\n    \"snippets\": \"/v1.1/instances/new-rivia/snippets/\"\n  },\n  \"created_at\": \"2015-05-18T18:26:24.116191Z\",\n  \"updated_at\": \"2016-03-10T19:06:27.272831Z\",\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\": \"Wild Hunt\"\n}"},{"name":null,"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"text","status":403}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Instance - rename","type":"endpoint","slug":"instance-rename","excerpt":"Rename your instance","body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Renaming an instance\",\n  \"body\": \"Be careful when renaming an instance -- as you use instance name in your applications, remember to change the name in the apps as well!\\n\\nAll applications trying to reach the old name of your instance will not work properly after the update.\"\n}\n[/block]","updates":[],"order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50629bdcde80d00498653","parentDoc":null,"__v":0,"createdAt":"2016-01-19T19:58:44.515Z","githubsync":"","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"},"editedParams":true,"project":"54774d9af3736008009e9e0e","editedParams2":true,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50629bdcde80d0049864d","56c50629bdcde80d0049864e","56c50629bdcde80d0049864f","56c50629bdcde80d00498650","56c50629bdcde80d00498651","56c50629bdcde80d00498652","56c50629bdcde80d00498653"],"title":"Instances","slug":"instances","order":1,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498637","__v":1,"project":"54774d9af3736008009e9e0e","createdAt":"2015-03-17T14:17:03.866Z","version":"56c50626bdcde80d00498635"},"user":"56996a013da4370d009d2127"}