cloudflash-commtouch

cloudflash-commtouch module implements commtouch configuration on cloudflash enabled devices

npm install cloudflash-commtouch
5 downloads in the last day
34 downloads in the last week
289 downloads in the last month

cloudflash-commtouch

List of commtouch APIs

VerbURIDescription
POST/commtouch/ctwsdTo create ctwsd configuration
GET/commtouch/ctwsdList summary of ctwsd configuration
GET/commtouch/ctwsd/:idList summary of ctwsd configuration by ID
PUT/commtouch/ctwsd/:idUpdate existing ctwsd configuration in VCG/CPEs by ID
DELETE/commtouch/ctwsd/:idTo delete existing ctwsd configuration by ID
POST/commtouchTo create commtouch configuration
GET/commtouchList summary of commtouch configuration
GET/commtouch/:idList summary of commtouch configuration by ID
PUT/commtouch/:idUpdate existing commtouch configuration in VCG/CPEs by ID
DELETE/commtouch/:idTo delete existing commtouch configuration by ID

commtouch ctwsd

Verb      URI                       Description
POST     /commtouch/ctwsd             ctwsd  configuration.

On success it returns JSON data with the UUID for the ctwsd created configuration.

Example Request and Response

Request JSON

{
"comment": "ctwsd Configuration File ",
"sections": [
    {
        "name": "General"
    },
    {
        "name": "WebSec",
        "params": {
            "ServerAddress": "webres%d.clearpath.ctmail.com",
            "LicenseKey": "0002B050A0565W056Y0I"
        }
    },
    {
        "name": "UDP",
        "params": {
            "Enabled": "yes",
            "Port": 5678,
            "ReceiveBuff": 65535,
            "MaxQueueSize": 3000,
            "RequestTimeout": 30,
            "BindingAddress": ""
        }
    },
    {
        "name": "HTTP"
    },
    {
        "name": "Stats"
    },
    {
        "name": "CustomCategories"
    }
]
}

Response JSON

{
   "comment": "ctwsd Configuration File ",
   "sections":
   [
       {
           "name": "General"
       },
       {
           "name": "WebSec",
           "params":
           {
               "ServerAddress": "webres%d.clearpath.ctmail.com",
               "LicenseKey": "0002B050A0565W056Y0I"
           }
       },
       {
           "name": "UDP",
           "params":
           {
               "Enabled": "yes",
               "Port": 5678,
               "ReceiveBuff": 65535,
               "MaxQueueSize": 3000,
               "RequestTimeout": 30,
               "BindingAddress": ""
           }
       },
       {
           "name": "HTTP"
       },
       {
           "name": "Stats"
       },
       {
           "name": "CustomCategories"
       }
   ],
   "id": "dbc864a4-d60c-41dc-8b57-bc27845431ec"
}

GET List

Verb       URI                        Description
GET           /commtouch/ctwsd        List summary of ctwsd configured.

Example Request and Response

Response JSON

[       
   {
   "comment": "ctwsd Configuration File ",
   "sections":
   [
       {
           "name": "General"
       },
       {
           "name": "WebSec",
           "params":
           {
               "ServerAddress": "webres%d.clearpath.ctmail.com",
               "LicenseKey": "0002B050A0565W056Y0I"
           }
       },
       {
           "name": "UDP",
           "params":
           {
               "Enabled": "yes",
               "Port": 5678,
               "ReceiveBuff": 65535,
               "MaxQueueSize": 3000,
               "RequestTimeout": 30,
               "BindingAddress": ""
           }
       },
       {
           "name": "HTTP"
       },
       {
           "name": "Stats"
       },
       {
           "name": "CustomCategories"
       }
   ],
   "id": "dbc864a4-d60c-41dc-8b57-bc27845431ec"
}

]

GET by ID:

Verb       URI                          Description
GET           /commtouch/ctwsd/:id        List summary of ctwsd configured by ID.

Example Request and Response

Response JSON

{
   "comment": "ctwsd Configuration File ",
   "sections":
   [
       {
           "name": "General"
       },
       {
           "name": "WebSec",
           "params":
           {
               "ServerAddress": "webres%d.clearpath.ctmail.com",
               "LicenseKey": "0002B050A0565W056Y0I"
           }
       },
       {
           "name": "UDP",
           "params":
           {
               "Enabled": "yes",
               "Port": 5678,
               "ReceiveBuff": 65535,
               "MaxQueueSize": 3000,
               "RequestTimeout": 30,
               "BindingAddress": ""
           }
       },
       {
           "name": "HTTP"
       },
       {
           "name": "Stats"
       },
       {
           "name": "CustomCategories"
       }
   ],
   "id": "dbc864a4-d60c-41dc-8b57-bc27845431ec"
}

PUT API

Verb       URI                          Description
PUT           /commtouch/ctwsd/:id        Update ctwsd configuration.

Example Request and Response

Request JSON

{
"comment": "ctwsd Configuration File  updated testing",
"sections": [        
    {
        "name": "General"
    },
    {
        "name": "WebSec",
        "params": {
            "ServerAddress": "webres%d.clearpath.ctmail.com",
            "LicenseKey": "0002B050A0565W056Y0I"
        }
    },
    {
        "name": "UDP",
        "params": {
            "Enabled": "yes",
            "Port": 5678,
            "ReceiveBuff": 65535,
            "MaxQueueSize": 3000,
            "RequestTimeout": 30,
            "BindingAddress": ""
        }
    },
    {
        "name": "HTTP"
    },
    {
        "name": "Stats"
    },
    {
        "name": "CustomCategories"
    }
]
}

Response JSON

{
   "comment": "ctwsd Configuration File updated testing",
   "sections":
   [
       {
           "name": "General"
       },
       {
           "name": "WebSec",
           "params":
           {
               "ServerAddress": "webres%d.clearpath.ctmail.com",
               "LicenseKey": "0002B050A0565W056Y0I"
           }
       },
       {
           "name": "UDP",
           "params":
           {
               "Enabled": "yes",
               "Port": 5678,
               "ReceiveBuff": 65535,
               "MaxQueueSize": 3000,
               "RequestTimeout": 30,
               "BindingAddress": ""
           }
       },
       {
           "name": "HTTP"
       },
       {
           "name": "Stats"
       },
       {
           "name": "CustomCategories"
       }
   ],
   "id": "dbc864a4-d60c-41dc-8b57-bc27845431ec"
}

DELETE ctwsd configuration

Verb      URI                            Description
DELETE   /commtouch/ctwsd/:id         Delete existing ctwsd configuration by ID.

Example Request and Response

Request Headers

DELETE http://10.2.56.194:5000/commtouch/ctwsd/dbc864a4-d60c-41dc-8b57-bc27845431ec

Response Header

Status Code : 204

commtouch

Verb      URI                       Description
POST     /commtouch         commtouch  configuration.

On success it returns JSON data with the UUID for the commtouch created configuration.

Example Request and Response

Request JSON

{
"commtouch": [
    {
        "commtouchNumber": 1,
        "name": "Advertisements & Pop-Ups",
        "description": "testing..."
    },
    {
        "commtouchNumber": 2,
        "name": "Alcohol & Tobacco"
    },
    {
        "commtouchNumber": 3,
        "name": "Anonymizers"
    },
    {
        "commtouchNumber": 4,
        "name": "Arts"
    },
    {
        "commtouchNumber": 5,
        "name": "Business"
    },
    {
        "commtouchNumber": 6,
        "name": "Transportation"
    },
    {
        "commtouchNumber": 7,
        "name": "Chat"
    },
    {
        "commtouchNumber": 9,
        "name": "Forums & Newsgroups"
    },
    {
        "commtouchNumber": 10,
        "name": "Compromised"
    }
]
}

Response JSON

{
   "commtouch":
   [
       {
           "commtouchNumber": 1,
           "name": "Advertisements & Pop-Ups",
           "description": "testing..."
       },
       {
           "commtouchNumber": 2,
           "name": "Alcohol & Tobacco"
       },
       {
           "commtouchNumber": 3,
           "name": "Anonymizers"
       },
       {
           "commtouchNumber": 4,
           "name": "Arts"
       },
       {
           "commtouchNumber": 5,
           "name": "Business"
       },
       {
           "commtouchNumber": 6,
           "name": "Transportation"
       },
       {
           "commtouchNumber": 7,
           "name": "Chat"
       },
       {
           "commtouchNumber": 9,
           "name": "Forums & Newsgroups"
       },
       {
           "commtouchNumber": 10,
           "name": "Compromised"
       }
   ],
   "id": "1ef9c4fa-0a74-4edb-9267-d5678121609e"
}

GET List

Verb       URI                        Description
GET           /commtouch        List summary of commtouch configured.

Example Request and Response

Response JSON

[
   {
       "commtouch":
       [
           {
               "commtouchNumber": 1,
               "name": "Advertisements & Pop-Ups",
               "description": "testing..."
           },
           {
               "commtouchNumber": 2,
               "name": "Alcohol & Tobacco"
           },
           {
               "commtouchNumber": 3,
               "name": "Anonymizers"
           },
           {
               "commtouchNumber": 4,
               "name": "Arts"
           },
           {
               "commtouchNumber": 5,
               "name": "Business"
           },
           {
               "commtouchNumber": 6,
               "name": "Transportation"
           },
           {
               "commtouchNumber": 7,
               "name": "Chat"
           },
           {
               "commtouchNumber": 9,
               "name": "Forums & Newsgroups"
           },
           {
               "commtouchNumber": 10,
               "name": "Compromised"
           }
       ],
       "id": "1ca2fe0c-cfa6-4a92-9deb-6e2a536d7f4b"
   }
]

GET by ID:

Verb       URI                          Description
GET           /commtouch/:id        List summary of commtouch configured by ID.

Example Request and Response

Response JSON

{
   "commtouch":
   [
       {
           "commtouchNumber": 1,
           "name": "Advertisements & Pop-Ups",
           "description": "testing..."
       },
       {
           "commtouchNumber": 2,
           "name": "Alcohol & Tobacco"
       },
       {
           "commtouchNumber": 3,
           "name": "Anonymizers"
       },
       {
           "commtouchNumber": 4,
           "name": "Arts"
       },
       {
           "commtouchNumber": 5,
           "name": "Business"
       },
       {
           "commtouchNumber": 6,
           "name": "Transportation"
       },
       {
           "commtouchNumber": 7,
           "name": "Chat"
       },
       {
           "commtouchNumber": 9,
           "name": "Forums & Newsgroups"
       },
       {
           "commtouchNumber": 10,
           "name": "Compromised"
       }
   ],
   "id": "1ca2fe0c-cfa6-4a92-9deb-6e2a536d7f4b"
}

PUT API

Verb       URI                          Description
PUT           /commtouch/:id       Update commtouch configuration.

Example Request and Response

Request JSON

{
"commtouch": [
    {
        "commtouchNumber": 11,
        "name": "Advertisements & Pop-Ups",
        "description": "testing..."
    },
    {
        "commtouchNumber": 12,
        "name": "Alcohol & Tobacco"
    },
    {
        "commtouchNumber": 13,
        "name": "Anonymizers"
    },
    {
        "commtouchNumber": 14,
        "name": "Arts"
    },
    {
        "commtouchNumber": 15,
        "name": "Business"
    },
    {
        "commtouchNumber": 16,
        "name": "Transportation"
    },
    {
        "commtouchNumber": 17,
        "name": "Chat"
    },
    {
        "commtouchNumber": 19,
        "name": "Forums & Newsgroups"
    },
    {
        "commtouchNumber": 20,
        "name": "Compromised"
    }
]
}

Response JSON

{
   "commtouch":
   [
       {
           "commtouchNumber": 11,
           "name": "Advertisements & Pop-Ups",
           "description": "testing..."
       },
       {
           "commtouchNumber": 12,
           "name": "Alcohol & Tobacco"
       },
       {
           "commtouchNumber": 13,
           "name": "Anonymizers"
       },
       {
           "commtouchNumber": 14,
           "name": "Arts"
       },
       {
           "commtouchNumber": 15,
           "name": "Business"
       },
       {
           "commtouchNumber": 16,
           "name": "Transportation"
       },
       {
           "commtouchNumber": 17,
           "name": "Chat"
       },
       {
           "commtouchNumber": 19,
           "name": "Forums & Newsgroups"
       },
       {
           "commtouchNumber": 20,
           "name": "Compromised"
       }
   ],
   "id": "1ca2fe0c-cfa6-4a92-9deb-6e2a536d7f4b"
}

DELETE commtouch configuration

Verb      URI                            Description
DELETE   /commtouch/:id         Delete existing commtouch configuration by ID.

Example Request and Response

Request Headers

DELETE http://10.2.56.194:5000/commtouch/1ca2fe0c-cfa6-4a92-9deb-6e2a536d7f4b

Response Header

Status Code : 204

npm loves you