Integrations
API Integration
This section provides information about API integration into your UTM device.
What is API Connection ? 🌐
The API connection helps you to use some of the advanced features of your UTM device. Some of them are as follows;
- Hotspot Authentication Process
- Hotspot Online User
- Deleting, adding, editing Hotspot users
- Pulling ARP (IP-MAC) table logs
- Pulling Firewall Objects
- Pulling Firewall Config
API User Authorization
| Brand | Hotspot | Arp Table | Objects | Config Backup |
|---|---|---|---|---|
Fortigate | User&Device=Read/Write
System=Read | User&Device=Read/Write
System=Read
Network=Read | User&Device=Read/Write
System=Read | Super Admin |
Sophos | Identity=Read/Write
System=Read | Network=Read | Objects=Read | Super Admin |
Palo Alto | Devices=Read/Write
System=Read | User&Device=Read/Write
System=Read
Network=Read | User&Device=Read/Write
System=Read | Super Admin |
For API connection, SSH and HTTPS protocols must be open from the ip address of the Logger software to your UTM device.
Remember that the authorizations of the user you will enter for the API connection will directly affect the operations you want to do! For example, in order to use the config backup service, it is recommended to make your API connection with a fully authorized user.
How To Use ?
To add a API connection, go to Management > Object > API Connections and then click Create New button.
Add API Connection
- Source: Enter the IP address of the device you want to establish the API connection.
- Name: API connection name.
- Provider: Select the brand of the device to establish the API connection.
- Description: Description of API connection.
- IP Address: Enter the IP address of the device you want to establish the API connection.
- Username: Enter the username of the device you want to establish the API connection.
- Password: Device Password.
- Port Number: Device HTTPS port number. Finally, enable status and click Add to save.