Table of Contents

Anchor
_Toc341972561 _Toc341972561

Attributes

...

Method:/configuration /createParameters:
{

{
    "attrs":

...

    {
        "category":"DGS",

...

        "name":"SMS",

...

        "description":"description",

...

        "options":

...

         "{
             \"provider\":\"clickatell\",
             \"username\":\"john.smith\",

...

             \"password\":\"secret\"

...

         }"
    }
}

{
    "error":0

...

}

Anchor
_Toc341972563 _Toc341972563

/ configuration / get

...

Code Block
language js title Parameters
{

...

"match":

...

[

...

["category", "=", "DGS"

...

],

...

["name", "=", "SMS"

...

]

...

], "return":

...

["*"

...

]

...

}

Code Block
language js title Reponse
{ "error":0

...

"result":

...

{ "id": "id", "category": "DGS", "name":"SMS", "description":"description", "options":

...

"{ \"provider\":\"clickatell\", \"username\":\"john.smith\", \"password\":\"secret\"

...

}" } }

Anchor
_Toc341972564 _Toc341972564

/ configuration / search

...

Code Block
language js title Parameters
{

...

"match":

...

[

...

["category", "=", "DGS"

...

],

...

["name", "=", "SMS"

...

]

...

], "return":

...

["*"

...

]

...

}

Code Block
language js title Reponse
{ "error":0

...

"result":

...

{ "total": 1,

...

"rows": [ {            "id": "id",            "category": "DGS",            "name":"SMS",            "description":"description",            "options":            "{                 \"provider\":\"clickatell\",                 \"username\":\"john.smith\",                 \"password\":\"secret\"             }" } ] } }

Anchor
_Toc341972565 _Toc341972565

/ configuration / delete

Method:/configuration /delete

{
    "id": "configuration object id"
}

{
    "error":0
}

Anchor
_Toc341972566 _Toc341972566

/ configuration / set

Method:/configuration /set

{
    "id": "configuration object id",
    "attrs":
    {
        "category":"DGS",
        "name":"SMS",
        "description":"description",
        "options":
         "{
             \"provider\":\"clickatell\

...

Method:/configuration /delete
Parameters:
{
"id":id
}
Response:
{
"error":0
}

...

Method:/configuration /set
Parameters:
{
"id":id,
"attrs":
{
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
}
Response:
{
"error":0
}

...

Method:/configuration /update
Parameters:
{
"attrs":
{
"category":"DGS",
"name":"SMS",
"description":"description",
"options":
'{
"provider":"clickatell",
"username":"john.smith",
"password":"secret"
}'
}
}
Response:
{
"error":0
}

...

1. SMTP server:

category:"CONNECTOR",
name:"SMTP",
options:
'{
"doc":
{
"serverURI":"192.168.222.1",
"serverPort":25,
"authRequired":false,
"useTLS":false,
"userName":"",
"password":""
}
}'

1. SMTP send OTP template

category:"TEMPLATE",
name:"SMTP_OTP",
options:
'\{
"subject":"OTP",
"from":"deepnetsecurity@gmail.com",
"to":"\[\[EMAIL\]\]",
"body":"Your one-time password: \[\[OTP\]\]",
"bodyFormat":"1",
"priority":"1"
\}'

1. SMS settings

category:"CONNECTOR",
name:"SMS",
options:
'\{
 "provider":
 \{ 
  "@name":"Clickatell",
  "username":"deepnet",
  "password":"d33p5pace",
  "sms":
  \{
   "http":
   \{
    "variables":
    \[
     \{
      "variable":
      \{
       "@name":"api_id",
       "@value":"389965"
      \}
     \}
    \]
   \}
  \},
  "wap":
  \{
   "http":
   \{  
    "variables":
    \[
     \{
      "variable":
      \{
       "@name":"api_id",
       "@value":"389965"
      \}
     \}
    \]
   \}
  \}
 \}
\}'
\\

1. SMS send OTP template

category:"TEMPLATE",
name:"SMS_OTP",
options:
'\{
 "from":"t.s.b@deepnetsecurity.com",
 "to":"\[\[MOBILE\]\]",
 "body":"Your one-time password: \[\[OTP\]\]"
\}'
\\

1. Twitter settings:

category:"CONNECTOR",
name:"TWITTER",
options:
'{
"doc":
{ "serverURI":'http://twitter.com/direct_messages/new.xml',
"userName":"deepnet",
"password":"314159"
}
}'

1. TeleSigh settings

...

",
       

...

      \

...

"username\":\"john.smith\",
      

...

       \"

...

password\":\"

...

secret\"

...

...

}"
    

...

}
}

{
    "error":0
}

Anchor
_Toc341972567 _Toc341972567

/ configuration / update

Method:/configuration /update

This API will create the configuration if it doesn't exist. Or it will update it, if it already exists.

{
    "

...

attrs":

...

...

{
        "

...

category":"

...

DGS",
        "

...

name":"

...

SMS",
      

...

  "description":"description",
        "

...

options":
         

...

"{

...

...

       \"

...

provider\":\"

...

clickatell\",
       

...

...

\"username\":\"john.smith\",
     

...

...

...

  \

...

1. SMTP send Emergency Code template

...

"password\":\"secret\"
         }"
    }
}

{
    "error":0
}

...