With the Kerio Control Administration API, you can programmatically access your Kerio Control server, integrate it with third-party solutions or write simple scripts to handle advanced administration tasks.
You just connect over HTTPS, send a request in a well-known human-readable format (JSON) and receive a response in the same format.
Scope
The administration API provides all actions that are available in the Control administration (our Control web administration uses the same Control Administration API).
As an example, you can list Traffic Rules, add new Rule, edit HTTP Filter, read Logs, setup Bandwidth Management – but the API is much more complex.
Out of Scope
Following features are not part of this API:
-
Kerio Control StaR Reports
-
Kerio Control Statistics
-
Kerio Control client
-
Kerio Control Web Filter
-
Settings or configuration which is not available in the web administration. The only way is to set the appropriate configuration file.
Licensing
Kerio API is a part of the Kerio products and is governed by the product’s license. In short, you need a license to run Kerio Control and the license also entitles you to use the API on your server.
Third-party independent software vendors may distribute their applications both for free or for profit. There is no royalty fee for the API. We only kindly ask you to let us know at
control-api@kerio.com about your applications.
Disclaimer
User acknowledges that Kerio provides no warranties with this API and makes no guarantees that it will operate continuously or for any specific purpose. Moreover, User agrees that Kerio cannot be held responsible for any defects in the API or for any negative or damaging impact on User’s operating environment as a result of the use thereof. If User experiences problems with the API, User acknowledges that Kerio is not obligated to correct such problems. Finally, User understands that Kerio may alter/update the API at any time and has no obligation to announce such changes.
