List Scripts

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Event Handling and Scripting >

List Scripts

List all scripts available to the virtual server.

 

Request

Method

URL

POST

/smserver-default/sms.ListScript

RAW

POST /smserver-default/sms.ListScript HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{}

]

Explained

Lists all existing scripts for the current virtual server.

 

Payload: a one-element JSON array with an empty object inside

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

[

       {

           "_id" : "GZVBKHGU4ZVEHP6KM2H3LJYMVU",

           "ScriptName" : "Test script",

           "ScriptLanguage" : "Pascal"

       },

       {

           "_id" : "PSLGM4V2Q7CENNYF6PJ42LUGSA",

           "ScriptName" : "clonato",

           "ScriptLanguage" : "Pascal"

       }

   ]

],"id":772674711}

Explained

A JSON array, each element of which represents a script with the following properties:

 

_id: the unique ID of the script

ScriptName: a short friendly name for the script

ScriptLanguage: the scripting language