{"_id":"56c50629bdcde80d0049865d","category":{"_id":"56c50628bdcde80d0049863a","pages":["56c50629bdcde80d00498654","56c50629bdcde80d00498655","56c50629bdcde80d00498656","56c50629bdcde80d00498657","56c50629bdcde80d00498658","56c50629bdcde80d00498659","56c50629bdcde80d0049865a","56c50629bdcde80d0049865b","56c50629bdcde80d0049865c","56c50629bdcde80d0049865d"],"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:13:34.744Z","from_sync":false,"order":5,"slug":"codebox","title":"Snippets - Scripts"},"editedParams2":true,"editedParams":true,"parentDoc":null,"project":"54774d9af3736008009e9e0e","user":"548193732dca603300bf6ea1","__v":0,"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"},"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-03T20:09:51.579Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"status\": \"pending\",\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/snippets/scripts/1/traces/3/\"\n  },\n  \"executed_at\": null,\n  \"result\": {},\n  \"duration\": null,\n  \"id\": 3\n}","name":""},{"language":"json","status":400,"code":"{\n  \"detail\": \"JSON parse error - No JSON object could be decoded\"\n}"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"status":404,"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"code":"curl -X POST \\\n-H \"X-API-KEY: API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"payload\":{\"KEY\":\"VALUE\"}}' \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/snippets/scripts/SCRIPT_ID/run/\"","name":"","language":"curl"},{"language":"python","code":"import syncano \nfrom syncano.models import Script\n\nconnection = syncano.connect(api_key=\"API_KEY\", instance_name=\"INSTANCE_NAME\")\n\ntrace = Script.please.run( \n    id=\"SCRIPT_ID\",\n    payload={'KEY': 'VALUE'}\n)\n"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\"});\nvar Script = connection.Script;\n\nvar query = {instanceName: \"INSTANCE_NAME\", id: 7};\nvar payload = {\"payload\":{\"KEY\":\"VALUE\"}}\n\nScript.please().run(query, payload).then(callback);","language":"javascript"}]},"auth":"required","params":[{"_id":"54d8b350628f540d00f3e4ae","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"54e766b27e677b23005325ab","ref":"","in":"path","required":true,"desc":"Script ID","default":"","type":"int","name":"script_id"},{"_id":"54e766b27e677b23005325aa","ref":"","in":"body","required":false,"desc":"Payload passed to the Script","default":"","type":"object","name":"payload"}],"url":"/instances/:instance_name/snippets/scripts/:script_id/run/"},"isReference":true,"order":9,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returns\"\n}\n[/block]\nInformation about the just launched Script.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Passing payload\",\n  \"body\": \"You can pass any number of additional arguments available for you in the ARGS dictionary. Please remember that this payload needs to be passed inside the `payload` dictionary, so the POST body should be in a form of:\\n`{\\\"payload\\\":{\\\"<KEY_1>\\\":\\\"<VALUE_1>\\\", \\\"<KEY_2>\\\":<VALUE_2>\\\"}}`\"\n}\n[/block]","excerpt":"Runs a chosen Script.\nRequires an `Account Key`.","slug":"script-run","type":"endpoint","title":"Script - run"}

postScript - run

Runs a chosen Script. Requires an `Account Key`.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
script_id:
required
integer
Script ID

Body Params

payload:
object
Payload passed to the Script

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Returns" } [/block] Information about the just launched Script. [block:callout] { "type": "info", "title": "Passing payload", "body": "You can pass any number of additional arguments available for you in the ARGS dictionary. Please remember that this payload needs to be passed inside the `payload` dictionary, so the POST body should be in a form of:\n`{\"payload\":{\"<KEY_1>\":\"<VALUE_1>\", \"<KEY_2>\":<VALUE_2>\"}}`" } [/block]

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