The base url for the web admin api is http(s)://yourwebadminserver/api/
Basic authentication is used with whatever user/password you’ve setup as the admin user. HTTPS is highly recommended.
Available in version 2.0.0:
– If you’ve locked down your web admin with a username and password, swagger documentation is available at /swagger. Please email [email protected] if you have additional questions.
– Web sockets can also be used to listen to firewall packets (if monitoring is enabled), along with system info for your machines. The path for web sockets is /performancecounter. There are three types of messages that can come through:
MonitorSystemData – contains system resource usage
{
'FQDN':'',
'IPAddress':'',
'MemoryTotal':0,
'MemoryAvailable':0,
'StorageTotal':0,
'StorageAvailable':0,
'CpuUsage':0.0,
'NetworkUsage':0.0,
'StorageIopsUsage':0.0
}MonitorFirewallData – contains real-time firewall packets that IPBan Pro is handling
[{
'FQDN':'',
'LocalIpAddress':'',
'LocalPort':0,
'RemoteGeo':'',
'RemoteIpAddress':'',
'RemotePort':0,
'RuleName':'',
'Protocol':0, // rfc 1700
'Allowed':false,
'Outbound':false
}]
MonitorCountryData – contains firewall packet counters aggregated by country
{
'[two-letter-iso]':
{
blocks: blockCount,
allows: allowCount
},
// repeated for other countries, they all come in one message
}