Skip to content
Bash client for pfSense-FauxAPI
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

PfsenseFauxapi - Shell Interface

A shell client for pfSense-FauxAPI -


# import fauxapi client functions from 
source "sources/"

# setup some variables

# generate an auth token to use
export fauxapi_auth=$(fauxapi_auth ${fauxapi_apikey} ${fauxapi_apisecret})

# make a pfSnese-FauxAPI call, in this example get the system configuration
system_config=$(fauxapi_config_get ${fauxapi_host})

# output in JSON pretty print using jq
echo "${system_config}" | jq . 

It is recommended to review the commented out samples in the provided file that cover all possible FauxAPI calls to gain a better idea on usage.

You can’t perform that action at this time.