WebApi

<back to all web services

ChangeScriptState

Sets the state of this script. Allows controlling backend execution by flagging module as active/paused

The following routes are available for this service:
PUT, OPTIONS/Scripts/{ScriptId}/state
ChangeScriptState Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
StatebodyScriptStateYesThe desired new state of the script

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Scripts/{ScriptId}/state HTTP/1.1 
Host: burntrouter.info 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Authorization":"String","ScriptId":"String","State":"Active"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

"Active"