{"_id":"56c5062abdcde80d00498663","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"},"githubsync":"","project":"54774d9af3736008009e9e0e","editedParams":true,"editedParams2":true,"__v":0,"parentDoc":null,"user":"54774c47f3736008009e9e0c","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-02-26T15:50:55.138Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"name\": \"say-hello\",\n  \"links\": {\n    \"reset-link\": \"/v1.1/instances/rivia/endpoints/scripts/say-hello/reset_link/\",\n    \"run\": \"/v1.1/instances/rivia/endpoints/scripts/say-hello/run/\",\n    \"script\": \"/v1.1/instances/rivia/snippets/scripts/1/\",\n    \"self\": \"/v1.1/instances/rivia/endpoints/scripts/say-hello/\",\n    \"public-link\": \"/v1.1/instances/rivia/endpoints/scripts/p/d98831f58d7d1456a5b65677b5d86c7bb572dcf0/say-hello/\",\n    \"traces\": \"/v1.1/instances/rivia/endpoints/scripts/say-hello/traces/\"\n  },\n  \"script\": 1,\n  \"public\": true,\n  \"public_link\": \"d98831f58d7d1456a5b65677b5d86c7bb572dcf0\",\n  \"description\": \"New description - say hello\"\n}","name":""},{"name":"","status":400,"language":"json","code":"{\n  \"detail\": \"JSON parse error - Expecting property name enclosed in double quotes: line 3 column 1 (char 21)\"\n}"},{"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}","status":403},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X PATCH \\\n-H \"X-API-KEY: <ACCOUNT_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"script\":1,\n    \"public\":true,\n    \"description\":\"New description - say hello\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/endpoints/scripts/<name>/\"","name":""},{"language":"python","code":"import syncano\nfrom syncano.models import ScriptEndpoint\n\nsyncano.connect(api_key='ACCOUNT_KEY', instance_name=\"INSTANCE_NAME\")\n\nScriptEndpoint.please.update(\n    name='SCRIPT_ENDPOINT_NAME',\n    script=SCRIPT_ID,\n    public=False\n)\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 update = {script: SCRIPT_ID, public: false};\n\nScriptEndpoint.please().update(query, update).then(callback)"}]},"method":"patch","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. It's the url endpoint you will be able to use to identify and run it. E.g. if your `name` is `my_script_endpoint`, you will be able to run it using link `/v1.1/instances/<instance_name>/endpoints/scripts/my_script_endpoint/run/`. Its maximum length is 64 characters, and it needs to consist only of letters, numbers, underscores or hyphens.","default":"","type":"string","name":"name"},{"_id":"54ef2ea25bf74a0d00ef40dc","ref":"","in":"body","required":false,"desc":"ID of a Script that the Script Endpoint will be connected to. Every time a script endpoints is called, it will run a connected Script.","default":"","type":"int","name":"script"},{"_id":"553a6d619a32920d008670e9","ref":"","in":"body","required":false,"desc":"Defines if added script endpoint will be public or not. Public script endpoints don't need any authentication method (neither Account nor API Key) to be run.","default":"","type":"boolean","name":"public"}],"url":"/instances/:instance_name/endpoints/scripts/:name/"},"isReference":true,"order":6,"body":"Updates chosen Script Endpoint.","excerpt":"Update Script Endpoints","slug":"endpoints-scripts-update-patch","type":"endpoint","title":"Endpoints - Scripts - update"}

patchEndpoints - Scripts - update

Update Script Endpoints

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name
name:
required
string
Script Endpoint name. It's the url endpoint you will be able to use to identify and run it. E.g. if your `name` is `my_script_endpoint`, you will be able to run it using link `/v1.1/instances/<instance_name>/endpoints/scripts/my_script_endpoint/run/`. Its maximum length is 64 characters, and it needs to consist only of letters, numbers, underscores or hyphens.

Body Params

script:
integer
ID of a Script that the Script Endpoint will be connected to. Every time a script endpoints is called, it will run a connected Script.
public:
boolean
Defines if added script endpoint will be public or not. Public script endpoints don't need any authentication method (neither Account nor API Key) to be run.

Examples


Result Format


Documentation

Updates chosen Script Endpoint.

User Information

Try It Out

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