The pfSense API is not installed by default.
To use this API, you'll need to install it and generate an authentication key.
Operations are very simple
- Open an SSH session or use the Unix console
- Select the option 8 to run the Shell.
- Run this command line:
pkg -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.7-pkg-API.pkg && /etc/rc.restart_webgui
Once executed, open the web administration console and go to “System” > “API”
- on the middle of the page, choose the option API Token inside the Authentication mode field.
- Generate a new token
- Retrieve the Client-ID and, at the top the web page displays temporary the generated API key
