Skip to content

Instantly share code, notes, and snippets.

@mike-perdide
Created September 16, 2025 12:19
Show Gist options
  • Select an option

  • Save mike-perdide/763299d0af5a78dfdf9de8ebc09fb97c to your computer and use it in GitHub Desktop.

Select an option

Save mike-perdide/763299d0af5a78dfdf9de8ebc09fb97c to your computer and use it in GitHub Desktop.
pfsense restapi configuration
<package>
<name>RESTAPI</name>
<internal_name>restapi</internal_name>
<descr><![CDATA[The missing REST API package for pfSense]]></descr>
<website>https://github.com/jaredhendrickson13/pfsense-api</website>
<category>System</category>
<version>%%PKGVERSION%%</version>
<configurationfile>restapi.xml</configurationfile>
<maintainer>[email protected]</maintainer>
<conf>
<enabled>enabled</enabled>
<read_only>disabled</read_only>
<keep_backup>enabled</keep_backup>
<login_protection>enabled</login_protection>
<log_successful_auth>disabled</log_successful_auth>
<hateoas>disabled</hateoas>
<expose_sensitive_fields>disabled</expose_sensitive_fields>
<override_sensitive_fields></override_sensitive_fields>
<allow_pre_releases>disabled</allow_pre_releases>
<allowed_interfaces>lan</allowed_interfaces>
<represent_interfaces_as>id</represent_interfaces_as>
<auth_methods>KeyAuth</auth_methods>
<ha_sync>disabled</ha_sync>
<ha_sync_hosts></ha_sync_hosts>
<ha_sync_username></ha_sync_username>
<ha_sync_password></ha_sync_password>
<ha_sync_validate_certs>disabled</ha_sync_validate_certs>
<server_key></server_key>
<jwt_exp>3600</jwt_exp>
<keys>
<key>
<descr><![CDATA[backend-pfs script token]]></descr>
<username><![CDATA[XXXXXXXXXXX]]></username>
<hash_algo>sha512</hash_algo>
<length_bytes>64</length_bytes>
<hash>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXx</hash>
</key>
</keys>
<access_list>
<item>
<type>allow</type>
<weight>10</weight>
<network>0.0.0.0/0</network>
<users></users>
<sched></sched>
<descr><![CDATA[Default allow all IPv4]]></descr>
</item>
<item>
<type>allow</type>
<weight>10</weight>
<network>0::/0</network>
<users></users>
<sched></sched>
<descr><![CDATA[Default allow all IPv6]]></descr>
</item>
</access_list>
</conf>
<include_file>/usr/local/pkg/RESTAPI/nginx.inc</include_file>
<plugins>
<item>
<type>plugin_nginx</type>
</item>
</plugins>
</package>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment