lb_firewall 1.0.3 lb_firewall: ^1.0.3 copied to clipboard
Logbot Firewall HTTP Service for: * Setup and gather informations about the firewall configuration * Setup and gather informations about the HTTP server configuration * Enable/Disable the firewall
Logbot Firewall SDK for Flutter #
Logbot Firewall HTTP Service for:
- Setup and gather informations about the firewall configuration
- Setup and gather informations about the HTTP server configuration
- Enable/Disable the firewall
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://tickets.io.logbotiot.cloud
Requirements #
Dart 2.17 or later
Installation & Usage #
Add the dependencies from pub.dev:
dependencies:
lb_auth:
lb_firewall:
lb_auth
is always required to make authorized calls to the APIs.
To use the SDK on you application see the example below:
import 'package:lb_auth/lb_auth.dart';
import 'package:lb_firewall/lb_firewall.dart';
class Example {
Future<void> run() async {
/// Initialize Logbot SDK by logging in with Logbot Credentials
await LogbotAuth.init(LogbotCredentials(
username: username,
password: password,
clientId: clientId,
clientSecret: clientSecret,
));
/// Starts the Logbot Discovery to search for local devices
await LogbotDiscovery.startDiscovery();
/// Starts the background service to retrieve device status every minute
/// (needed to read device status from cache)
LogbotStateManager.start();
/// Now you can use every API included on the SDK
/// for example:
Configuration? response = await LogbotFirewall.config.getConfig();
}
}
Tests #
To run all tests:
flutter test
Documentation for API Endpoints #
All URIs are relative to https://devices.logbotiot.cloud
Class | Method | HTTP request | Description |
---|---|---|---|
ConfigurationApi | constraints | GET /config/constraints | Get configuration constraints |
ConfigurationApi | getConfig | GET /config | Get service configuration |
ConfigurationApi | setConfig | POST /config | Set a new configuration |
ConfigurationApi | validate | POST /config/validate | Validates a given configuration |
InfoApi | health | GET /health | Check Logbot Firewall status |
InfoApi | version | GET /version | Get Logbot Firewall version |
LogsApi | getIpsLogs | GET /logs/ips | Retrive IPS logs |
ServiceApi | disable | PUT /service/disable | Disables firewall |
ServiceApi | enable | PUT /service/enable | Enables firewall |
ServiceApi | restart | PUT /service/restart | Restarts firewall |
ServiceApi | status | GET /service | Get service status |
Documentation For Models #
- Boot
- BootError
- Configuration
- ConfigurationConstraints
- ConfigurationConstraintsConnections
- ConfigurationConstraintsPorts
- Connection
- Error
- Firewall
- IpTableError
- Ips
- LbFirewallStatus
- Log
- Mode
- Policy
- ProtocolL4
- ProtocolL7
- Protocols
- Service
- StatusFirewall
- StatusIps
- StatusRouter
- Version
Author #
Logbot SRL info@logbot.cloud