Installation and Configuration

Requirements

Hardware requirements

Overall, the REST API package is designed to be as lightweight as possible and should run fine on any hardware that can run pfSense. It's recommended to follow Netgate's minimum hardware requirements.

Warning

  • The package is currently not compatible with 32-bit builds of pfSense. It is recommended to use the legacy v1 package for 32-bit systems.
  • While the package should behave identically on 64-bit architectures other than amd64, automated testing only covers amd64 builds of pfSense. Support on other architectures is not guaranteed.

Supported pfSense versions

  • pfSense CE 2.7.2
  • pfSense Plus 24.03

Tip

Don't see your version of pfSense? Older versions of pfSense may be supported by older versions of this package. Check the releases page.

Installing the package

The pfSense REST API package is built just like any other pfSense package and can therefor be installed easily using pkg from the pfSense command line. Below are the installation commands for the latest version of the package.

Install on pfSense CE

pkg-static add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.7.2-pkg-RESTAPI.pkg

Install on pfSense Plus

pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-24.03-pkg-RESTAPI.pkg

Important

  • You may need to customize the installation command to reference the package built for your pfSense version. Check the releases page to find the package built for your version of pfSense.
  • When updating pfSense, you must reinstall this package afterward as pfSense removes unofficial packages during system updates and has no way to automatically reinstall them.

Configuring the package

The REST API is designed to be ready to use out of the box. However, there are a number of configuration options available to you to customize the API to your needs. The REST API settings can be configured in pfSense webConfigurator under 'System' -> 'REST API' or via PATCH request to the /api/v2/system/restapi/settings endpoint.

Deleting the package

To remove the REST API package from your pfSense instance, you can use the following command:

pfsense-restapi delete

Note

In the event that you are unable to use the pfsense-restapi command, you can manually remove the package by running pkg-static delete pfSense-pkg-RESTAPI.

Updating the package

You can update the package to latest version available to your pfSense version by running the following command:

pfsense-restapi update

Reverting the package to a specific version

If you need to revert or upgrade the package to a specific version, you can do so by running the following command:

pfsense-restapi revert <version>