node package manager

stormlight

stormlight provides identification, authorization, activation of stormflash agents, does policy management

Stormlight

Stormlight is basically one of the stormstack modules which inherits JSON objects from all the other stormflash modules such as corenova-strom, openvpn-storm, commtouch-storm by importing these modules. When a mobile device changes the policy, stormlight needs to identify new changes and find out the respective stormflash modules which get affected and then build the JSON format which is expected by each of these modules to update configuration in VSC.

List of stromlight APIs

VerbURIDescription
POST/domainsTo create Domain configuration
GET/domains/:idList summary of Domain configuration
PUT/domains/:idUpdate existing Domain configuration in stormlight by domain ID
DELETE/domains/:idTo delete existing domains configuration by ID
POST/domains/:id/policiesTo create policies configuration in respective domains by ID
GET/domains/:id/policiesList summary of policies configuration in domains by ID
PUT/domains/:id/policies/:pidUpdate existing policy configuration in domains by ID
GET/domains/:id/policies/:pidList summary of policies configuration in domains policies by ID
DELETE/domains/:id/policies/:sidTo delete existing policies configuration in domains by policies ID
POST/domains/:id/metapolicyTo create metapolicies configuration in respective domains by ID
GET/domains/:id/metapolicyList summary of metapolicy configuration by domains ID
PUT/domains/:id/metapolicy/:pidUpdate existing metapolicy configuration in domains by metapolicy ID
GET/domains/:id/metapolicy/:pidList summary of metapolicy configuration in domains by metapolicies ID
DELETE/domains/:id/metapolicy/:gidTo delete existing metapolicy configuration by ID
POST/domains/:id/metapolicy/:metapolicyid/groupsTo create metapolicies configuration in domains by ID
GET/domains/:id/metapolicy/:metapolicyid/groupsList summary of metapolicy configuration by domains ID
PUT/domains/:id/metapolicy/:metapolyid/groups/:gidUpdate existing groups configuration by gropus ID
GET/domains/:id/metapolicy/:metapolicyid/groups/:gidList summary of groups configuration by groups ID
DELETE/domains/:id/metapolicy/:metapolicyid/groups/:gidDelete existing groups configuration by ID
POST/domains/:id/agentsTo create agents configuration in respective domains by ID
GET/domains/:id/agentsList summary of agents configuration by domains agents ID
PUT/domains/:id/agents/:aidUpdate existing agents configuration by domains agents ID
GET/domains/:id/agents/:aidList summary of agents configuration by domains agents ID
DELETE/domains/:id/agents/:aidTo delete existing agents configuration by domains agents ID
PUT/domains/:id/policies/:pid/versions/:vidUpdate existing versions configuration by versions ID

POST Domains API

Verb      URI                       Description
POST      /domains                  Creates the Domains  configuration.

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

Example Request and Response

Request JSON

{
    "name": "string",
    "description": "string",
    "metapolicy": {
        "name": "string",
        "description": "string",
        "enabled": true,
        "groups": [
            {
                "id": "uuid",
                "name": "string",
                "description": "string",
                "identities": [
                    {
                        "type": "user.cname",
                        "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                    }
                ],
                "networks": [
                    {
                        "id": "uuid",
                        "cidr": "192.168.100.0/24",
                        "family": "IPv4"
                    }
                ],
                "rules": [
                    {
                        "policy": "policy uuid",
                        "during": "business hours"
                    }
                ]
            }
        ],
        "activeVersion": "string",
        "versions": [
            {
                "id": "uuid",
                "version": "string",
                "config": {
                    "SSL_INSPECT_CABUNDLE": {
                        "filename": "ca-cert.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "SSL_INSPECT_CACERT": {
                        "filename": "rootcert.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "SSL_INSPECT_CAKEY": {
                        "filename": "rootkey.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CABUNDLE": {
                        "filename": "ca-bundle.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CACERT": {
                        "filename": "openvpn.cert",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CAKEY": {
                        "filename": "openvpn.key",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    }
                },
                "lastModified": "timestamp"
            }
        ],
        "default": false,
        "createdAt": "string",
        "lastModified": "string"
    },
    "policies": [
        {
            "name": "string",
            "description": "string",
            "enabled": true,
            "activeVersion": "string",
            "versions": [
                {
                    "id": "uuid",
                    "version": "string",
                    "config": {
                        "web": {
                            "contentFilter": {
                                "enable": true,
                                "commtouch": {
                                    "blockedList": [
                                        2,
                                        3,
                                        4
                                    ],
                                    "enable": false,
                                    "name": "default"
                                },
                                "safesearch": {
                                    "enable": false
                                },
                                "customFilter": {
                                    "blacklist": [
                                        "www.site.com"
                                    ],
                                    "custom": false,
                                    "name": "Default Policy Exception",
                                    "whitelist": [
                                        "www.site.com"
                                    ]
                                },
                                "kaspersky": {
                                    "download": true,
                                    "enable": true,
                                    "upload": true
                                }
                            }
                        },
                        "mail": {
                            "kaspersky": {
                                "enable": true,
                                "imap": true,
                                "pop3": true,
                                "smtp": true
                            }
                        },
                        "ssl": {
                            "inspection": {
                                "enable": false,
                                "inspectSubDomain": true,
                                "showWarning": true,
                                "exceptions": [
                                    {
                                        "custom": false,
                                        "name": "ssl inspection exceptions",
                                        "whitelist": [
                                            "www.site.com"
                                        ]
                                    }
                                ]
                            },
                            "connectionFilter": {
                                "enable": false,
                                "includeSubDomain": false,
                                "restrictSelfSignedCert": false,
                                "restrictSslCert": false,
                                "exceptions": [
                                    {
                                        "blacklist": [
                                            "www.site.com"
                                        ],
                                        "custom": false,
                                        "name": "ssl connection exceptions"
                                    }
                                ]
                            }
                        }
                    },
                    "lastModified": "timestamp"
                }
            ],
            "default": false,
            "createdAt": "string",
            "lastModified": "string"
        }
    ],
    "agents": [
        "2328f438-b1e2-4e2d-b521-f7151e4285c9"
    ],
    "packages": [],
    "services": [
        "web.kaspersky",
        "web.contentfiltering",
        "mail.kaspersky",
        "ssl.certificateinspection",
        "ssl.contentinspection"
    ],
    "enabled": true
}

Response JSON

{
   "name": "string",
   "description": "string",
   "metapolicy":
   {
       "name": "string",
       "description": "string",
       "enabled": true,
       "groups":
       [
           {
               "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
               "name": "string",
               "description": "string",
               "identities":
               [
                   {
                       "type": "user.cname",
                       "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                   }
               ],
               "networks":
               [
                   {
                       "id": "uuid",
                       "cidr": "192.168.100.0/24",
                       "family": "IPv4"
                   }
               ],
               "rules":
               [
                   {
                       "policy": "policy uuid",
                       "during": "business hours"
                   }
               ]
           }
       ],
       "activeVersion": "0.0",
       "versions":
       [
           {
               "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
               "version": "0.0",
               "config":
               {
                   "SSL_INSPECT_CABUNDLE":
                   {
                       "filename": "ca-cert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CACERT":
                   {
                       "filename": "rootcert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CAKEY":
                   {
                       "filename": "rootkey.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CABUNDLE":
                   {
                       "filename": "ca-bundle.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CACERT":
                   {
                       "filename": "openvpn.cert",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CAKEY":
                   {
                       "filename": "openvpn.key",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   }
               },
               "lastModified": "05:13:2014 11:09:58"
           }
       ],
       "default": false,
       "createdAt": "string",
       "lastModified": "string",
       "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
   },
   "policies":
   [
       {
           "name": "string",
           "description": "string",
           "enabled": true,
           "activeVersion": "0.0",
           "versions":
           [
               {
                   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
                   "version": "0.0",
                   "config":
                   {
                       "web":
                       {
                           "contentFilter":
                           {
                               "enable": true,
                               "commtouch":
                               {
                                   "blockedList":
                                   [
                                       2,
                                       3,
                                       4
                                   ],
                                   "enable": false,
                                   "name": "default"
                               },
                               "safesearch":
                               {
                                   "enable": false
                               },
                               "customFilter":
                               {
                                   "blacklist":
                                   [
                                       "www.site.com"
                                   ],
                                   "custom": false,
                                   "name": "Default Policy Exception",
                                   "whitelist":
                                   [
                                       "www.site.com"
                                   ]
                               },
                               "kaspersky":
                               {
                                   "download": true,
                                   "enable": true,
                                   "upload": true
                               }
                           }
                       },
                       "mail":
                       {
                           "kaspersky":
                           {
                               "enable": true,
                               "imap": true,
                               "pop3": true,
                               "smtp": true
                           }
                       },
                       "ssl":
                       {
                           "inspection":
                           {
                               "enable": false,
                               "inspectSubDomain": true,
                               "showWarning": true,
                               "exceptions":
                               [
                                   {
                                       "custom": false,
                                       "name": "ssl inspection exceptions",
                                       "whitelist":
                                       [
                                           "www.site.com"
                                       ]
                                   }
                               ]
                           },
                           "connectionFilter":
                           {
                               "enable": false,
                               "includeSubDomain": false,
                               "restrictSelfSignedCert": false,
                               "restrictSslCert": false,
                               "exceptions":
                               [
                                   {
                                       "blacklist":
                                       [
                                           "www.site.com"
                                       ],
                                       "custom": false,
                                       "name": "ssl connection exceptions"
                                   }
                               ]
                           }
                       }
                   },
                   "lastModified": "05:13:2014 11:09:58"
               }
           ],
           "default": false,
           "createdAt": "string",
           "lastModified": "string",
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
       }
   ],
   "agents":
   [
       "2328f438-b1e2-4e2d-b521-f7151e4285c9"
   ],
   "packages":
   [
   ],
   "services":
   [
       "web.kaspersky",
       "web.contentfiltering",
       "mail.kaspersky",
       "ssl.certificateinspection",
       "ssl.contentinspection"
   ],
   "enabled": true,
   "id": "39625f7e-a71e-450e-b8d1-c2ba37ffe0b1"
}

GET List API

Verb       URI	                    Description
GET	       /domains/:id   	        List summary of domains configured.

Example Request and Response

Response JSON

 {
   "name": "string",
   "description": "string",
   "metapolicy":
   {
       "name": "string",
       "description": "string",
       "enabled": true,
       "groups":
       [
           {
               "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
               "name": "string",
               "description": "string",
               "identities":
               [
                   {
                       "type": "user.cname",
                       "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                   }
               ],
               "networks":
               [
                   {
                       "id": "uuid",
                       "cidr": "192.168.100.0/24",
                       "family": "IPv4"
                   }
               ],
               "rules":
               [
                   {
                       "policy": "policy uuid",
                       "during": "business hours"
                   }
               ]
           }
       ],
       "activeVersion": "0.0",
       "versions":
       [
           {
               "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
               "version": "0.0",
               "config":
               {
                   "SSL_INSPECT_CABUNDLE":
                   {
                       "filename": "ca-cert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CACERT":
                   {
                       "filename": "rootcert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CAKEY":
                   {
                       "filename": "rootkey.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CABUNDLE":
                   {
                       "filename": "ca-bundle.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CACERT":
                   {
                       "filename": "openvpn.cert",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CAKEY":
                   {
                       "filename": "openvpn.key",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   }
               },
               "lastModified": "05:13:2014 11:09:58"
           }
       ],
       "default": false,
       "createdAt": "string",
       "lastModified": "string",
       "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
   },
   "policies":
   [
       {
           "name": "string",
           "description": "string",
           "enabled": true,
           "activeVersion": "0.0",
           "versions":
           [
               {
                   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
                   "version": "0.0",
                   "config":
                   {
                       "web":
                       {
                           "contentFilter":
                           {
                               "enable": true,
                               "commtouch":
                               {
                                   "blockedList":
                                   [
                                       2,
                                       3,
                                       4
                                   ],
                                   "enable": false,
                                   "name": "default"
                               },
                               "safesearch":
                               {
                                   "enable": false
                               },
                               "customFilter":
                               {
                                   "blacklist":
                                   [
                                       "www.site.com"
                                   ],
                                   "custom": false,
                                   "name": "Default Policy Exception",
                                   "whitelist":
                                   [
                                       "www.site.com"
                                   ]
                               },
                               "kaspersky":
                               {
                                   "download": true,
                                   "enable": true,
                                   "upload": true
                               }
                           }
                       },
                       "mail":
                       {
                           "kaspersky":
                           {
                               "enable": true,
                               "imap": true,
                               "pop3": true,
                               "smtp": true
                           }
                       },
                       "ssl":
                       {
                           "inspection":
                           {
                               "enable": false,
                               "inspectSubDomain": true,
                               "showWarning": true,
                               "exceptions":
                               [
                                   {
                                       "custom": false,
                                       "name": "ssl inspection exceptions",
                                       "whitelist":
                                       [
                                           "www.site.com"
                                       ]
                                   }
                               ]
                           },
                           "connectionFilter":
                           {
                               "enable": false,
                               "includeSubDomain": false,
                               "restrictSelfSignedCert": false,
                               "restrictSslCert": false,
                               "exceptions":
                               [
                                   {
                                       "blacklist":
                                       [
                                           "www.site.com"
                                       ],
                                       "custom": false,
                                       "name": "ssl connection exceptions"
                                   }
                               ]
                           }
                       }
                   },
                   "lastModified": "05:13:2014 11:09:58"
               }
           ],
           "default": false,
           "createdAt": "string",
           "lastModified": "string",
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
       }
   ],
   "agents":
   [
       "2328f438-b1e2-4e2d-b521-f7151e4285c9"
   ],
   "packages":
   [
   ],
   "services":
   [
       "web.kaspersky",
       "web.contentfiltering",
       "mail.kaspersky",
       "ssl.certificateinspection",
       "ssl.contentinspection"
   ],
   "enabled": true,
   "id": "39625f7e-a71e-450e-b8d1-c2ba37ffe0b1"
}

PUT API

Verb       URI                          Description
PUT	       /domains/:id    	            Update the domains configuration by domains ID.

On success it returns JSON data with the UUID with the domains updated configuration by domains ID.

Example Request and Response

Request JSON

{
    "name": "string",
    "description": "string",
    "metapolicy": {
        "name": "string",
        "description": "string",
        "enabled": true,
        "groups": [
            {
                "id": "uuid",
                "name": "string",
                "description": "string",
                "identities": [
                    {
                        "type": "user.cname",
                        "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                    }
                ],
                "networks": [
                    {
                        "id": "uuid",
                        "cidr": "192.168.100.0/24",
                        "family": "IPv4"
                    }
                ],
                "rules": [
                    {
                        "policy": "policy uuid",
                        "during": "business hours"
                    }
                ]
            }
        ],
        "activeVersion": "string",
        "versions": [
            {
                "id": "uuid",
                "version": "string",
                "config": {
                    "SSL_INSPECT_CABUNDLE": {
                        "filename": "ca-cert.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "SSL_INSPECT_CACERT": {
                        "filename": "rootcert.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "SSL_INSPECT_CAKEY": {
                        "filename": "rootkey.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CABUNDLE": {
                        "filename": "ca-bundle.pem",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CACERT": {
                        "filename": "openvpn.cert",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    },
                    "OPENVPN_CAKEY": {
                        "filename": "openvpn.key",
                        "encoding": "base64",
                        "data": "base64 encoded data"
                    }
                },
                "lastModified": "timestamp"
            }
        ],
        "default": false,
        "createdAt": "string",
        "lastModified": "string"
    },
    "policies": [
        {
            "name": "string",
            "description": "string",
            "enabled": true,
            "activeVersion": "string",
            "versions": [
                {
                    "id": "uuid",
                    "version": "string",
                    "config": {
                        "web": {
                            "contentFilter": {
                                "enable": true,
                                "commtouch": {
                                    "blockedList": [
                                        2,
                                        3,
                                        4
                                    ],
                                    "enable": false,
                                    "name": "default"
                                },
                                "safesearch": {
                                    "enable": false
                                },
                                "customFilter": {
                                    "blacklist": [
                                        "www.site.com"
                                    ],
                                    "custom": false,
                                    "name": "Default Policy Exception",
                                    "whitelist": [
                                        "www.site.com"
                                    ]
                                },
                                "kaspersky": {
                                    "download": true,
                                    "enable": true,
                                    "upload": true
                                }
                            }
                        },
                        "mail": {
                            "kaspersky": {
                                "enable": true,
                                "imap": true,
                                "pop3": true,
                                "smtp": true
                            }
                        },
                        "ssl": {
                            "inspection": {
                                "enable": false,
                                "inspectSubDomain": true,
                                "showWarning": true,
                                "exceptions": [
                                    {
                                        "custom": false,
                                        "name": "ssl inspection exceptions",
                                        "whitelist": [
                                            "www.site.com"
                                        ]
                                    }
                                ]
                            },
                            "connectionFilter": {
                                "enable": false,
                                "includeSubDomain": false,
                                "restrictSelfSignedCert": false,
                                "restrictSslCert": false,
                                "exceptions": [
                                    {
                                        "blacklist": [
                                            "www.site.com"
                                        ],
                                        "custom": false,
                                        "name": "ssl connection exceptions"
                                    }
                                ]
                            }
                        }
                    },
                    "lastModified": "timestamp"
                }
            ],
            "default": false,
            "createdAt": "string",
            "lastModified": "string"
        }
    ],
    "agents": [
        "2328f438-b1e2-4e2d-b521-f7151e4285c9"
    ],
    "packages": [],
    "services": [
        "web.kaspersky",
        "web.contentfiltering",
        "mail.kaspersky",
        "ssl.certificateinspection",
        "ssl.contentinspection"
    ],
    "enabled": true
}

Response JSON

{
   "name": "string",
   "description": "string",
   "metapolicy":
   {
       "name": "string",
       "description": "string",
       "enabled": true,
       "groups":
       [
           {
               "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
               "name": "string",
               "description": "string",
               "identities":
               [
                   {
                       "type": "user.cname",
                       "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                   }
               ],
               "networks":
               [
                   {
                       "id": "uuid",
                       "cidr": "192.168.100.0/24",
                       "family": "IPv4"
                   }
               ],
               "rules":
               [
                   {
                       "policy": "policy uuid",
                       "during": "business hours"
                   }
               ]
           }
       ],
       "activeVersion": "0.0",
       "versions":
       [
           {
               "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
               "version": "0.0",
               "config":
               {
                   "SSL_INSPECT_CABUNDLE":
                   {
                       "filename": "ca-cert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CACERT":
                   {
                       "filename": "rootcert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CAKEY":
                   {
                       "filename": "rootkey.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CABUNDLE":
                   {
                       "filename": "ca-bundle.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CACERT":
                   {
                       "filename": "openvpn.cert",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CAKEY":
                   {
                       "filename": "openvpn.key",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   }
               },
               "lastModified": "05:13:2014 11:09:58"
           }
       ],
       "default": false,
       "createdAt": "string",
       "lastModified": "string",
       "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
   },
   "policies":
   [
       {
           "name": "string",
           "description": "string",
           "enabled": true,
           "activeVersion": "0.0",
           "versions":
           [
               {
                   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
                   "version": "0.0",
                   "config":
                   {
                       "web":
                       {
                           "contentFilter":
                           {
                               "enable": true,
                               "commtouch":
                               {
                                   "blockedList":
                                   [
                                       2,
                                       3,
                                       4
                                   ],
                                   "enable": false,
                                   "name": "default"
                               },
                               "safesearch":
                               {
                                   "enable": false
                               },
                               "customFilter":
                               {
                                   "blacklist":
                                   [
                                       "www.site.com"
                                   ],
                                   "custom": false,
                                   "name": "Default Policy Exception",
                                   "whitelist":
                                   [
                                       "www.site.com"
                                   ]
                               },
                               "kaspersky":
                               {
                                   "download": true,
                                   "enable": true,
                                   "upload": true
                               }
                           }
                       },
                       "mail":
                       {
                           "kaspersky":
                           {
                               "enable": true,
                               "imap": true,
                               "pop3": true,
                               "smtp": true
                           }
                       },
                       "ssl":
                       {
                           "inspection":
                           {
                               "enable": false,
                               "inspectSubDomain": true,
                               "showWarning": true,
                               "exceptions":
                               [
                                   {
                                       "custom": false,
                                       "name": "ssl inspection exceptions",
                                       "whitelist":
                                       [
                                           "www.site.com"
                                       ]
                                   }
                               ]
                           },
                           "connectionFilter":
                           {
                               "enable": false,
                               "includeSubDomain": false,
                               "restrictSelfSignedCert": false,
                               "restrictSslCert": false,
                               "exceptions":
                               [
                                   {
                                       "blacklist":
                                       [
                                           "www.site.com"
                                       ],
                                       "custom": false,
                                       "name": "ssl connection exceptions"
                                   }
                               ]
                           }
                       }
                   },
                   "lastModified": "05:13:2014 11:09:58"
               }
           ],
           "default": false,
           "createdAt": "string",
           "lastModified": "string",
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
       }
   ],
   "agents":
   [
       "2328f438-b1e2-4e2d-b521-f7151e4285c9"
   ],
   "packages":
   [
   ],
   "services":
   [
       "web.kaspersky",
       "web.contentfiltering",
       "mail.kaspersky",
       "ssl.certificateinspection",
       "ssl.contentinspection"
   ],
   "enabled": true,
   "id": "39625f7e-a71e-450e-b8d1-c2ba37ffe0b1"
}

DELETE Domains API

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

Example Request and Response

Request Headers

DELETE http://stormlight:8282/domains/:id

Response Header

Status Code : 204

POST Policies API

Verb       URI                          Description
POST	     /domains/:id/policies    	  Create policies configuration in domains.

On success it returns JSON data with the UUID for the policies created configuration in domains by ID.

Example Request and Response

Request JSON

{
   "name": "put policies",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               12,
                               13,
                               14
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}

Response JSON

{
   "name": "put policies",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.1",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               2,
                               3,
                               4
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       },
       {
           "id": "8e35756e-efaf-47f2-b803-19829bf8b7ab",
           "version": "0.1",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               12,
                               13,
                               14
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:18:56"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}

GET Policies API

Verb       URI                          Description
GET	       /domains/:id/policies    	  List summary of policies configuration in domains.

Example Request and Response

Response JSON

[
   {
       "name": "string",
       "description": "string",
       "enabled": true,
       "activeVersion": "0.0",
       "versions":
       [
           {
               "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
               "version": "0.0",
               "config":
               {
                   "web":
                   {
                       "contentFilter":
                       {
                           "enable": true,
                           "commtouch":
                           {
                               "blockedList":
                               [
                                   2,
                                   3,
                                   4
                               ],
                               "enable": false,
                               "name": "default"
                           },
                           "safesearch":
                           {
                               "enable": false
                           },
                           "customFilter":
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "Default Policy Exception",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           },
                           "kaspersky":
                           {
                               "download": true,
                               "enable": true,
                               "upload": true
                           }
                       }
                   },
                   "mail":
                   {
                       "kaspersky":
                       {
                           "enable": true,
                           "imap": true,
                           "pop3": true,
                           "smtp": true
                       }
                   },
                   "ssl":
                   {
                       "inspection":
                       {
                           "enable": false,
                           "inspectSubDomain": true,
                           "showWarning": true,
                           "exceptions":
                           [
                               {
                                   "custom": false,
                                   "name": "ssl inspection exceptions",
                                   "whitelist":
                                   [
                                       "www.site.com"
                                   ]
                               }
                           ]
                       },
                       "connectionFilter":
                       {
                           "enable": false,
                           "includeSubDomain": false,
                           "restrictSelfSignedCert": false,
                           "restrictSslCert": false,
                           "exceptions":
                           [
                               {
                                   "blacklist":
                                   [
                                       "www.site.com"
                                   ],
                                   "custom": false,
                                   "name": "ssl connection exceptions"
                               }
                           ]
                       }
                   }
               },
               "lastModified": "05:13:2014 11:09:58"
           }
       ],
       "default": false,
       "createdAt": "string",
       "lastModified": "string",
       "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
   }
]

PUT Plocies API

Verb       URI                          Description
PUT	       /domains/:id/policies/:pid	  Update policies configuration by PID.

On success it returns JSON data with the UUID for the policies upadted configuration in domains by policies ID.

Example Request and Response

Request JSON

{
   "name": "put policies",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               12,
                               13,
                               14
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}

Response JSON

{
   "name": "put policies",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.1",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               2,
                               3,
                               4
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       },
       {
           "id": "8e35756e-efaf-47f2-b803-19829bf8b7ab",
           "version": "0.1",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               12,
                               13,
                               14
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:18:56"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}

GET Policies API

Verb       URI                          Description
GET	       /domains/:id/policies/:pid	  List the summary of policies configuration by PID.

Example Request and Response

Response JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               2,
                               3,
                               4
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}

DELETE API

Verb      URI                            Description
DELETE    /domains/:id/policies/:pid     Delete existing policies configuration by PID.

Example Request and Response

Request Headers

DELETE http://stormlight:8282/domains/:id/policies/:pid

Response Header

Status Code : 204

POST API

Verb      URI                       Description
POST      /domains/:id/metapolicy   Create metapolicy  configuration.

On success it returns JSON data with the UUID for the metapolicy created configuration in domains by metapolicy ID.

Example Request and Response

Request JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "groups":
   [
       {
           "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
           "name": "string",
           "description": "string",
           "identities":
           [
               {
                   "type": "user.cname",
                   "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
               }
           ],
           "networks":
           [
               {
                   "id": "uuid",
                   "cidr": "192.168.100.0/24",
                   "family": "IPv4"
               }
           ],
           "rules":
           [
               {
                   "policy": "policy uuid",
                   "during": "business hours"
               }
           ]
       }
   ],
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
           "version": "0.0",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
}

Response JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "groups":
   [
       {
           "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
           "name": "string",
           "description": "string",
           "identities":
           [
               {
                   "type": "user.cname",
                   "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
               }
           ],
           "networks":
           [
               {
                   "id": "uuid",
                   "cidr": "192.168.100.0/24",
                   "family": "IPv4"
               }
           ],
           "rules":
           [
               {
                   "policy": "policy uuid",
                   "during": "business hours"
               }
           ]
       }
   ],
   "activeVersion": "0.1",
   "versions":
   [
       {
           "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
           "version": "0.0",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       },
       {
           "id": "c0e93646-aeb2-4632-838f-1fd58e9b7191",
           "version": "0.1",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 12:03:43"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
}

GET API

Verb       URI	                        Description
GET	       /domains/:id/metapolicy    	List summary of metapolicy configured.

Example Request and Response

Response JSON

[
   {
       "name": "string",
       "description": "string",
       "enabled": true,
       "groups":
       [
           {
               "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
               "name": "string",
               "description": "string",
               "identities":
               [
                   {
                       "type": "user.cname",
                       "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
                   }
               ],
               "networks":
               [
                   {
                       "id": "uuid",
                       "cidr": "192.168.100.0/24",
                       "family": "IPv4"
                   }
               ],
               "rules":
               [
                   {
                       "policy": "policy uuid",
                       "during": "business hours"
                   }
               ]
           }
       ],
       "activeVersion": "0.0",
       "versions":
       [
           {
               "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
               "version": "0.0",
               "config":
               {
                   "SSL_INSPECT_CABUNDLE":
                   {
                       "filename": "ca-cert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CACERT":
                   {
                       "filename": "rootcert.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "SSL_INSPECT_CAKEY":
                   {
                       "filename": "rootkey.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CABUNDLE":
                   {
                       "filename": "ca-bundle.pem",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CACERT":
                   {
                       "filename": "openvpn.cert",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   },
                   "OPENVPN_CAKEY":
                   {
                       "filename": "openvpn.key",
                       "encoding": "base64",
                       "data": "base64 encoded data"
                   }
               },
               "lastModified": "05:13:2014 11:09:58"
           }
       ],
       "default": false,
       "createdAt": "string",
       "lastModified": "string",
       "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
   }
]

PUT API

Verb       URI	                            Description
PUT	       /domains/:id/metapolicy/:pid    	Update existing metapolicy configuration by metapolicy ID.

Example Request and Response

On success it returns JSON data with the UUID for the metapolicy updated configuration in domains by metapolicy ID.

Request JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "groups":
   [
       {
           "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
           "name": "string",
           "description": "string",
           "identities":
           [
               {
                   "type": "user.cname",
                   "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
               }
           ],
           "networks":
           [
               {
                   "id": "uuid",
                   "cidr": "192.168.100.0/24",
                   "family": "IPv4"
               }
           ],
           "rules":
           [
               {
                   "policy": "policy uuid",
                   "during": "business hours"
               }
           ]
       }
   ],
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
           "version": "0.0",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
}

Response JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "groups":
   [
       {
           "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
           "name": "string",
           "description": "string",
           "identities":
           [
               {
                   "type": "user.cname",
                   "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
               }
           ],
           "networks":
           [
               {
                   "id": "uuid",
                   "cidr": "192.168.100.0/24",
                   "family": "IPv4"
               }
           ],
           "rules":
           [
               {
                   "policy": "policy uuid",
                   "during": "business hours"
               }
           ]
       }
   ],
   "activeVersion": "0.1",
   "versions":
   [
       {
           "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
           "version": "0.0",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       },
       {
           "id": "c0e93646-aeb2-4632-838f-1fd58e9b7191",
           "version": "0.1",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 12:03:43"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
}

GET List

Verb       URI	                            Description
GET	       /domains/:id/metapolicy/:pid    	List summary of metapolicy configuration in domains by metapolicies ID.

Example Request and Response

Response JSON

{
   "name": "string",
   "description": "string",
   "enabled": true,
   "groups":
   [
       {
           "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
           "name": "string",
           "description": "string",
           "identities":
           [
               {
                   "type": "user.cname",
                   "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
               }
           ],
           "networks":
           [
               {
                   "id": "uuid",
                   "cidr": "192.168.100.0/24",
                   "family": "IPv4"
               }
           ],
           "rules":
           [
               {
                   "policy": "policy uuid",
                   "during": "business hours"
               }
           ]
       }
   ],
   "activeVersion": "0.0",
   "versions":
   [
       {
           "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26",
           "version": "0.0",
           "config":
           {
               "SSL_INSPECT_CABUNDLE":
               {
                   "filename": "ca-cert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CACERT":
               {
                   "filename": "rootcert.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "SSL_INSPECT_CAKEY":
               {
                   "filename": "rootkey.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CABUNDLE":
               {
                   "filename": "ca-bundle.pem",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CACERT":
               {
                   "filename": "openvpn.cert",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               },
               "OPENVPN_CAKEY":
               {
                   "filename": "openvpn.key",
                   "encoding": "base64",
                   "data": "base64 encoded data"
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "string",
   "id": "6a1f9cd7-ca4a-463e-b22f-787e62652f26"
}

DELETE API

Verb      URI                              Description
DELETE    /domains/:id/metapolicy/:gid     Delete existing ctwsd configuration by ID.

Example Request and Response

Request Headers

DELETE http://stormlight:8282/domains/:id/metapolicy/:gid

Response Header

Status Code : 204

POST API

Verb       URI	                                            Description
POST       /domains/:id/metapolicy/:metapolicyid/groups    	Create the groups configuration in domains by metapolicies ID.

Example Request and Response

On success it returns JSON data with the UUID for the groups created configuration in domains by groups ID.

Request JSON

{
   "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
   "name": "put groups",
   "description": "string",
   "identities":
   [
       {
           "type": "user.cname",
           "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
       }
   ],
   "networks":
   [
       {
           "id": "uuid",
           "cidr": "192.168.100.0/24",
           "family": "IPv4"
       }
   ],
   "rules":
   [
       {
           "policy": "policy uuid",
           "during": "business hours"
       }
   ]
}

Response JSON

{
   "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
   "name": "put groups",
   "description": "string",
   "identities":
   [
       {
           "type": "user.cname",
           "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
       }
   ],
   "networks":
   [
       {
           "id": "uuid",
           "cidr": "192.168.100.0/24",
           "family": "IPv4"
       }
   ],
   "rules":
   [
       {
           "policy": "policy uuid",
           "during": "business hours"
       }
   ]
}

GET List

Verb       URI	                                            Description
GET	       /domains/:id/metapolicy/:metapolicyid/groups    	List summary of groups configuration in domains by metapolicies ID.

Example Request and Response

Response JSON

[
   {
       "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
       "name": "string",
       "description": "string",
       "identities":
       [
           {
               "type": "user.cname",
               "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
           }
       ],
       "networks":
       [
           {
               "id": "uuid",
               "cidr": "192.168.100.0/24",
               "family": "IPv4"
           }
       ],
       "rules":
       [
           {
               "policy": "policy uuid",
               "during": "business hours"
           }
       ]
   }
]

PUT API

Verb       URI	                                                  Description
PUT	       /domains/:id/metapolicy/:metapolicyid/groups/:gid    	Update the groups configuration in domains by metapolicies groups ID.

Example Request and Response

On success it returns JSON data with the UUID for the groups updated configuration in domains by groups ID.

Request JSON

{
   "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
   "name": "put groups",
   "description": "string",
   "identities":
   [
       {
           "type": "user.cname",
           "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
       }
   ],
   "networks":
   [
       {
           "id": "uuid",
           "cidr": "192.168.100.0/24",
           "family": "IPv4"
       }
   ],
   "rules":
   [
       {
           "policy": "policy uuid",
           "during": "business hours"
       }
   ]
}

Response JSON

{
   "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
   "name": "put groups",
   "description": "string",
   "identities":
   [
       {
           "type": "user.cname",
           "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
       }
   ],
   "networks":
   [
       {
           "id": "uuid",
           "cidr": "192.168.100.0/24",
           "family": "IPv4"
       }
   ],
   "rules":
   [
       {
           "policy": "policy uuid",
           "during": "business hours"
       }
   ]
}

GET API

Verb       URI	                                                  Description
GET	       /domains/:id/metapolicy/:metapolicyid/groups/:gid    	List summary of groups configuration in domains by metapolicies groups ID.

Example Request and Response

Response JSON

{
   "id": "a36a59dc-2de5-46a9-9e18-a7fb0c48b368",
   "name": "string",
   "description": "string",
   "identities":
   [
       {
           "type": "user.cname",
           "value": "a2cdff9d-293d-413d-b07a-dc497b123527"
       }
   ],
   "networks":
   [
       {
           "id": "uuid",
           "cidr": "192.168.100.0/24",
           "family": "IPv4"
       }
   ],
   "rules":
   [
       {
           "policy": "policy uuid",
           "during": "business hours"
       }
   ]
}

DELETE API

Verb      URI                                                   Description
DELETE    /domains/:id/metapolicy/:metapolicyid/groups/:gid     Delete existing groups configuration by ID.

Example Request and Response

Request Headers

DELETE http://stormlight:8282/domains/:id/metapolicy/:metapolicyid/groups/:gid

Response Header

Status Code : 204

POST API

Verb       URI	                    Description
POST       /domains/:id/agents    	Create the agents configuration in domains by ID.

Example Request and Response

On success it returns JSON data with the UUID for the agents created configuration in domains by agents ID.

Request JSON

{
     "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
     "status": "INACTIVE",
     "statusPercent": 50,
     "environment":
     {
     },
     "packages":
     {
     },
     "os":
     {
     },
     "name": "default Agent",
     "description": "default Agent",
     "enabled": true
 }

Response JSON

{
   "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
   "status": "INACTIVE",
   "statusPercent": 50,
   "environment":
   {
   },
   "packages":
   {
   },
   "os":
   {
   },
   "name": "default Agent",
   "description": "default Agent",
   "enabled": false
}

GET API

Verb       URI	                    Description
GET        /domains/:id/agents    	List summary of agents configuration in domains by ID.

Example Request and Response

Response JSON

[
   {
       "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
       "status": "INACTIVE",
       "statusPercent": 50,
       "environment":
       {
       },
       "packages":
       {
       },
       "os":
       {
       },
       "name": "default Agent",
       "description": "default Agent",
       "enabled": false
   }
]

PUT API

Verb       URI	                        Description
PUT        /domains/:id/agents/:aid    	Update the agents configuration in domains by ID.

Example Request and Response

On success it returns JSON data with the UUID for the agents updated configuration in domains by agents ID.

Request JSON

{
     "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
     "status": "INACTIVE",
     "statusPercent": 50,
     "environment":
     {
     },
     "packages":
     {
     },
     "os":
     {
     },
     "name": "default Agent",
     "description": "default Agent",
     "enabled": true
 }

Response JSON

{
   "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
   "status": "INACTIVE",
   "statusPercent": 50,
   "environment":
   {
   },
   "packages":
   {
   },
   "os":
   {
   },
   "name": "default Agent",
   "description": "default Agent",
   "enabled": false
}

GET List

Verb       URI	                        Description
GET        /domains/:id/agents/:aid    	List Summary of agents configuration in domains by agents ID.

Example Request and Response

Response JSON

{
   "id": "2328f438-b1e2-4e2d-b521-f7151e4285c9",
   "status": "INACTIVE",
   "statusPercent": 50,
   "environment":
   {
   },
   "packages":
   {
   },
   "os":
   {
   },
   "name": "default Agent",
   "description": "default Agent",
   "enabled": false
}

DELETE API

Verb      URI                           Description
DELETE    /domains/:id/agents/:aid      Delete existing agents configuration by agents ID.

Example Request and Response

Request Headers

DELETE http://stormlight:8282/domains/:id/agents/:aid

Response Header

Status Code : 204

PUT API

Verb       URI	                                        Description
PUT        /domains/:id/policies/:pid/versions/:vid    	Update the versions configuration in domains by evrsions ID.

Example Request and Response

On success it returns JSON data with the UUID for the policies versions updated configuration in domains by versions ID.

Request JSON

{
    "web": {
        "contentFilter": {
           "commtouch": 
            {
                 "blockedList": [2,3,47]
           }
        }
    }
}

Response JSON

{
   "name": "put policies",
   "description": "string",
   "enabled": true,
   "activeVersion": "0.1",
   "versions":
   [
       {
           "id": "540900a4-73d7-45e7-8683-7238e0d13bf1",
           "version": "0.0",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               2,
                               3,
                               47
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:09:58"
       },
       {
           "id": "8e35756e-efaf-47f2-b803-19829bf8b7ab",
           "version": "0.1",
           "config":
           {
               "web":
               {
                   "contentFilter":
                   {
                       "enable": true,
                       "commtouch":
                       {
                           "blockedList":
                           [
                               12,
                               13,
                               14
                           ],
                           "enable": false,
                           "name": "default"
                       },
                       "safesearch":
                       {
                           "enable": false
                       },
                       "customFilter":
                       {
                           "blacklist":
                           [
                               "www.site.com"
                           ],
                           "custom": false,
                           "name": "Default Policy Exception",
                           "whitelist":
                           [
                               "www.site.com"
                           ]
                       },
                       "kaspersky":
                       {
                           "download": true,
                           "enable": true,
                           "upload": true
                       }
                   }
               },
               "mail":
               {
                   "kaspersky":
                   {
                       "enable": true,
                       "imap": true,
                       "pop3": true,
                       "smtp": true
                   }
               },
               "ssl":
               {
                   "inspection":
                   {
                       "enable": false,
                       "inspectSubDomain": true,
                       "showWarning": true,
                       "exceptions":
                       [
                           {
                               "custom": false,
                               "name": "ssl inspection exceptions",
                               "whitelist":
                               [
                                   "www.site.com"
                               ]
                           }
                       ]
                   },
                   "connectionFilter":
                   {
                       "enable": false,
                       "includeSubDomain": false,
                       "restrictSelfSignedCert": false,
                       "restrictSslCert": false,
                       "exceptions":
                       [
                           {
                               "blacklist":
                               [
                                   "www.site.com"
                               ],
                               "custom": false,
                               "name": "ssl connection exceptions"
                           }
                       ]
                   }
               }
           },
           "lastModified": "05:13:2014 11:18:56"
       }
   ],
   "default": false,
   "createdAt": "string",
   "lastModified": "05:13:2014 12:17:18",
   "id": "540900a4-73d7-45e7-8683-7238e0d13bf1"
}