diff --git a/api.md b/api.md index f1031b9..d4d20d9 100644 --- a/api.md +++ b/api.md @@ -81,6 +81,23 @@ Action|Description|Parameters #### Description ### Filters #### Description +The filters module has API that will allow you manage all aspects of the Filter module externally, such as getting client data or adding clients. It is used like so: +``` +{ + "module": "Filters", + "action": "getClientData" +} +``` +Action|Description|Parameters +------|-----------|---------- +`getClientData`|Return an array of client filters. (Mode and Filters)|_none_ +`getSSIDData`|Return an array of SSID filters (Mode and Filters)|_none_ +`toggleClientMode`|Toggle between whitelist and blacklist mode for client filtering|_none_ +`toggleSSIDMode`|Toggle between whitelist and blacklist mode for SSID filtering|_none_ +`addClient`|Add client to filter| +`addSSID`|Add SSID to filter| +`removeClient`|Remove client from filter| +`removeSSID`|Remove SSID from filter| ### Logging #### Description The Logging module provides easy access to the syslog, dmesg, PineAP and Reporting logs. To use these API functions, send your api request with the "module" set to "Logging":