{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X DELETE \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\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\", instance_name=\"INSTANCE_NAME\")\n\nInstance.please.delete()"},{"code":"var Syncano = require('syncano');\nvar connection = Syncano({accountKey: 'ACCOUNT_KEY'});\nvar Instance = connection.Instance;\n\nInstance.please().delete({\"name\":\"example_name\"}).then(callback);","language":"javascript"}]},"method":"delete","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"547c4ee9deb8310800db015e"}],"results":{"codes":[{"language":"json","code":"(empty)","name":"","status":204},{"code":"{\n  \"detail\": \"Not found\"\n}","language":"json","status":404},{"status":403,"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json"}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Instance - delete","type":"endpoint","slug":"instance-delete","excerpt":"","body":"This call will delete an Instance. A successful request will return a 204 Status Code with empty body.","updates":[],"order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50629bdcde80d00498652","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"},"githubsync":"","parentDoc":null,"project":"54774d9af3736008009e9e0e","__v":0,"createdAt":"2015-02-10T13:08:38.677Z","editedParams":true,"editedParams2":true,"user":"54774c47f3736008009e9e0c","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"}}

deleteInstance - delete


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Examples


Result Format


Documentation

This call will delete an Instance. A successful request will return a 204 Status Code with empty body.

User Information

Try It Out

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