Netgate Discussion Forum
    • Categories
    • Recent
    • Tags
    • Popular
    • Users
    • Search
    • Register
    • Login

    FauxAPI :: A REST API interface for pfSense to facilitate dev-ops

    Scheduled Pinned Locked Moved Development
    6 Posts 4 Posters 10.1k Views
    Loading More Posts
    • Oldest to Newest
    • Newest to Oldest
    • Most Votes
    Reply
    • Reply as topic
    Log in to reply
    This topic has been deleted. Only users with topic management privileges can see it.
    • N
      ndj
      last edited by

      Hi,

      I'm looking for feedback on a pfSense package I've created, FauxAPI that provides a REST style API interface to pfSense 2.3+

      At this stage

      • feedback on any glaring problems with the release would be very much appreciated
      • input on best/accepted practices in releasing pfSense packages into the pfSense FreeBSD-ports tree would be helpful
      • I'll likely avoid adding new features in the immediate term until the release process is more clear to me

      Code can found here:-
      https://github.com/ndejong/pfsense_fauxapi

      A pfSense package release can be downloaded here to save you needing to build:-
      https://github.com/ndejong/pfsense_fauxapi/tree/master/package

      N

      1 Reply Last reply Reply Quote 0
      • C
        chuchuchu
        last edited by

        @ndejong:

        Hi,

        I'm looking for feedback on a pfSense package I've created, FauxAPI that provides a REST style API interface to pfSense 2.3+

        At this stage

        • feedback on any glaring problems with the release would be very much appreciated
        • input on best/accepted practices in releasing pfSense packages into the pfSense FreeBSD-ports tree would be helpful
        • I'll likely avoid adding new features in the immediate term until the release process is more clear to me

        Code can found here:-
        https://github.com/ndejong/pfsense_fauxapi

        A pfSense package release can be downloaded here to save you needing to build:-
        https://github.com/ndejong/pfsense_fauxapi/tree/master/package

        N

        begin testing for this. Thanks in advance for your work

        greetings from germany,

        chris

        1 Reply Last reply Reply Quote 0
        • A
          archenroot
          last edited by

          Great stuff this is actually the future to go, provide common configuration interface for remote management.

          I use pfSense and being happy how stable it is, but now wanted to create some more complex kind of VPN setup, traffic shaping, network rules via custom web pages with autoconfiguration and this is the way of course in these days.

          Thanks a lot for this effort!

          I will look at this and will let you know.

          1 Reply Last reply Reply Quote 0
          • A
            archenroot
            last edited by

            Actually I saw also some project regarding new pfSense web GUI interface and I think it might be good approach (based on my experience - I am doing microservice and SOA solution) to make this new face working via REST API completely.

            I found some ticket https://redmine.pfsense.org/issues/5719, but the referred github project doesn't exist anymore…

            1 Reply Last reply Reply Quote 0
            • H
              heper
              last edited by

              That redmine is unrelated to rest

              1 Reply Last reply Reply Quote 0
              • N
                ndj
                last edited by

                FauxAPI has received an update to v1.1

                In brief:-

                • new API call alias_update_urltables - forces the immediate update of remote URL tables
                • new API call gateway_status - returns the current status of the gateways
                • updated documentation
                • tested against pfSense 2.3.2 and 2.3.3

                The package has received some great feedback and users deploying in complex large environments - enjoy, send feedback.

                N

                1 Reply Last reply Reply Quote 0
                • First post
                  Last post
                Copyright 2025 Rubicon Communications LLC (Netgate). All rights reserved.