To Get Started Using Plugin, You Need The PFSense API

This forum is for the description and instruction on how plugin works and should be used.
Post Reply
User avatar
Cubert
Posts: 2430
Joined: Tue Dec 29, 2015 7:57 pm
8
Contact:

To Get Started Using Plugin, You Need The PFSense API

Post by Cubert »

The PFSense Manager for ConnectWise Automate plugin uses the pfSense-API to create a REST environment on the pfSense device. This allows Automate to communicate with the pfSense devices to push and pull data and settings. Without this API the plugin can not talk to the firewall.

The API documentation is available on GitHub at https://github.com/jaredhendrickson13/pfsense-api


To install the API, Log into your devices Web Configurator and at the Web Command Prompt execute the following one line.

For CE2.5 devices:

Code: Select all

pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.5-pkg-API.txz && /etc/rc.restart_webgui
For CE2.6 devices:

Code: Select all

pkg add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.6-pkg-API.txz && /etc/rc.restart_webgui
  • In order for pfSense to apply some required web server changes, it is required to restart the webConfigurator after installing the package
  • If you do not have shell access to pfSense, you can still install via the webConfigurator by navigating to 'Diagnostics > Command Prompt' and enter the commands there
  • When updating pfSense, you must reinstall pfSense API afterwards. Unfortunately, pfSense removes all existing packages and only re-installs packages found within pfSense's package repositories. Since pfSense API is not an official package in pfSense's repositories, it does not get reinstalled automatically.

Post Reply

Return to “Documentation Project”