A REST API or CLI to configure pfSense

[maayan]

Hello,

I am reviewing possibilities for integration with pfSense and I'm looking for a REST API or CLI.

Do you know if there is something available?

Thanks.

[jimp]

Not yet, but it's on the roadmap.

[ndj]

You could try the FauxAPI pfSense package together with the pfsense-fauxapi Python package that provides both a Python library interface and a command-line interface.

---

FauxAPI package install

set fauxapi_base_package_url='https://raw.githubusercontent.com/ndejong/pfsense_fauxapi_packages/master'
set set fauxapi_latest=`fetch -qo - ${fauxapi_base_package_url}/LATEST`
fetch ${fauxapi_base_package_url}/${fauxapi_latest}
pkg-static install ${fauxapi_latest}

• https://github.com/ndejong/pfsense_fauxapi

---

pfsense-fauxapi client side install

pip3 install pfsense-fauxapi

• https://github.com/ndejong/pfsense_fauxapi_client_python