{"_id":"56e3153e00383b0e00d46d9b","parentDoc":null,"user":"548193732dca603300bf6ea1","__v":0,"category":{"_id":"56c50628bdcde80d0049863c","__v":2,"pages":["56c5062abdcde80d0049865e","56c5062abdcde80d0049865f","56c5062abdcde80d00498660","56c5062abdcde80d00498661","56c5062abdcde80d00498662","56c5062abdcde80d00498663","56c5062abdcde80d00498664","56c5062abdcde80d00498665","56c5062abdcde80d00498666","56e3153e00383b0e00d46d9b"],"project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-03-17T14:12:47.418Z","from_sync":false,"order":9,"slug":"webhooks","title":"Endpoints - Scripts"},"editedParams":true,"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"},"project":"54774d9af3736008009e9e0e","editedParams2":true,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-11T18:58:06.324Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X GET \\\n-H \"X-API-KEY: ACCOUNT_KEY\" \\\n-H \"Content-Type: application/json\" \\\n\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/endpoints/scripts/NAME/run/?monster=Manticore\"","name":""},{"language":"python","code":"import syncano \nfrom syncano.models import ScriptEndpoint\n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\nscript_endpoint = ScriptEndpoint.please.get(\n    name='SCRIPT_ENDPOINT_NAME'\n)\n\nrun_script = script_endpoint.run()\nprint(run_script.result)\n"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar ScriptEndpoint = connection.ScriptEndpoint;\n\nvar query = {instanceName: \"INSTANCE_NAME\", name: \"NAME\"};\nvar payload = {\"payload\":{\"monster\":\"Manticore\"}};\n\nScriptEndpoint.please().run(query, payload).then(callback)"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"status\": \"success\",\n  \"duration\": 33,\n  \"result\": {\n    \"stderr\": \"\",\n    \"stdout\": \"Hello \\nARGS: {u'POST': {}, u'GET': {u'hello': u'hello'}}\\nGET: {u'hello': u'hello'}\\nPOST: {}\"\n  },\n  \"executed_at\": \"2016-03-11T19:00:41.084364Z\",\n  \"id\": 7\n}","name":""},{"status":400,"language":"json","code":"{\n  \"detail\": \"JSON parse error - Expecting object: line 1 column 1 (char 0)\"\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"auth":"required","params":[{"_id":"54ef26a74b06700d0062d151","ref":"","in":"path","required":true,"desc":"Instance name","default":"","type":"string","name":"instance_name"},{"_id":"54ef29b631a42421007599c5","ref":"","in":"path","required":true,"desc":"Script Endpoint name","default":"","type":"string","name":"name"},{"_id":"555feb5d5884610d00bba240","ref":"","in":"query","required":false,"desc":"Payload to pass to the script endpoint (should be in a form of JSON object)","default":"","type":"object","name":"payload"}],"url":"/instances/:instance_name/endpoints/scripts/:name/run/"},"isReference":true,"order":3,"body":"Runs a Script Endpoint with a given slug (name). You can pass extra arguments in the POST request body (or in the url if using GET). A Script associated with a Script Endpoint will be able to read it using the `ARGS` dictionary.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Script Endpoint can be run using either as GET or  as POST methods. Which one to choose is completely up to you, but in general -- using POST will make it easier to pass more arguments into the code.\",\n  \"title\": \"GET or POST\"\n}\n[/block]\n\n### Payload\n\nWhen running a webhook, you can pass extra arguments in the request. You can do it either by passing the JSON object directly (when using POST):\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"'{\\\"monster\\\":\\\"Manticore\\\"}'\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nor by adding arguments in the URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/endpoints/scripts/NAME/run/?monster=Manticore\\\"\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Public Script Endpoints\",\n  \"body\": \"If a Script Endpoint is public, it can be run by anyone with the public link. To use this endpoint, API Key will still be needed.\"\n}\n[/block]","excerpt":"","slug":"endpoints-scripts-run-get","type":"endpoint","title":"Endpoints - Scripts - run"}

getEndpoints - Scripts - run


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
name:
required
string
Script Endpoint name

Query Params

payload:
object
Payload to pass to the script endpoint (should be in a form of JSON object)

Examples


Result Format


Documentation

Runs a Script Endpoint with a given slug (name). You can pass extra arguments in the POST request body (or in the url if using GET). A Script associated with a Script Endpoint will be able to read it using the `ARGS` dictionary. [block:callout] { "type": "info", "body": "Script Endpoint can be run using either as GET or as POST methods. Which one to choose is completely up to you, but in general -- using POST will make it easier to pass more arguments into the code.", "title": "GET or POST" } [/block] ### Payload When running a webhook, you can pass extra arguments in the request. You can do it either by passing the JSON object directly (when using POST): [block:code] { "codes": [ { "code": "'{\"monster\":\"Manticore\"}'", "language": "json" } ] } [/block] or by adding arguments in the URL [block:code] { "codes": [ { "code": "\"https://api.syncano.io/v1.1/instances/INSTANCE_NAME/endpoints/scripts/NAME/run/?monster=Manticore\"", "language": "curl" } ] } [/block] [block:callout] { "type": "info", "title": "Public Script Endpoints", "body": "If a Script Endpoint is public, it can be run by anyone with the public link. To use this endpoint, API Key will still be needed." } [/block]

User Information

Try It Out

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