{"_id":"56c50630bdcde80d004986a5","user":"54774c47f3736008009e9e0c","editedParams2":true,"editedParams":true,"githubsync":"","project":"54774d9af3736008009e9e0e","__v":0,"parentDoc":null,"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"},"category":{"_id":"56c50628bdcde80d0049863b","project":"54774d9af3736008009e9e0e","__v":1,"pages":["56c50630bdcde80d004986a0","56c50630bdcde80d004986a1","56c50630bdcde80d004986a2","56c50630bdcde80d004986a3","56c50630bdcde80d004986a4","56c50630bdcde80d004986a5","56c50630bdcde80d004986a6","56c50630bdcde80d004986a7"],"version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:14:54.509Z","from_sync":false,"order":7,"slug":"codebox-schedules","title":"Schedules"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-23T13:36:19.312Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":204,"language":"json","code":"(empty)","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"settings":"56c50c06d1b8770d00922288","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>/schedules/<schedule_id>/\"","name":""},{"code":"import syncano\nfrom syncano.models import Schedule\n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\nSchedule.please.delete(id=SCHEDULE_ID)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Schedule = connection.Schedule;\n\nvar query = {\n  id: 7,\n  instanceName: \"INSTANCE_NAME\"\n};\n\nSchedule.please().delete(query).then(callback)","language":"javascript"}]},"method":"delete","auth":"required","params":[{"_id":"54d8b350628f540d00f3e4ae","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"54eb2cd32adfde0d00740154","ref":"","in":"path","required":true,"desc":"Schedule id","default":"","type":"int","name":"schedule_id"}],"url":"/instances/:instance_name/schedules/:schedule_id/"},"isReference":true,"order":5,"body":"Deletes a Schedule.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Schedule Traces\",\n  \"body\": \"Please remember that when deleting a Schedule, you also delete all Traces associated with it.\\n\\nIf you have any important information there you wouldn't like to lose remember to store the trace's data in data objects before removing the schedule.\"\n}\n[/block]","excerpt":"","slug":"schedules-delete","type":"endpoint","title":"Schedules - delete"}

deleteSchedules - delete


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
schedule_id:
required
integer
Schedule id

Examples


Result Format


Documentation

Deletes a Schedule. [block:callout] { "type": "warning", "title": "Schedule Traces", "body": "Please remember that when deleting a Schedule, you also delete all Traces associated with it.\n\nIf you have any important information there you wouldn't like to lose remember to store the trace's data in data objects before removing the schedule." } [/block]

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