pfSense firewall

v0.4.1

Operate a pfSense firewall over its REST API: read firewall rules, NAT, aliases, virtual IPs, interface / gateway (config + status) / service / VPN status, DHCP leases, routes, ARP, CARP, pf tables, installed packages, the config-change history, and firewall / system / auth / DHCP / OpenVPN logs, plus a few gated mutators (apply filter, flush states, restart a service, reboot). Uses the community pfSense-pkg-RESTAPI package (/api/v2), which runs on the firewall and works across CE and Plus.

34 allowed by default 2 need approval 1 denied by default

Pack ID

pfsense

Vendor

emisar

linux

Actions

Required binaries. Install these on the host before relying on the pack — an action that calls a missing one fails at run time.


              curl

jq

Install

emisar pack install validates the pack and verifies its content hash before copying it into /etc/emisar/packs. The --hash below pins the install to the exact bytes on this page — a tampered copy is rejected. After install, reload the runner; it re-reads the catalog and advertises every action.

content hash: sha256:0857d187604a41ed1f9cb3be56f442c9e2abaa428f4b988b6cdd00e51ed6eadc

on the runner host

sudo emisar pack install pfsense \
  --hash sha256:0857d187604a41ed1f9cb3be56f442c9e2abaa428f4b988b6cdd00e51ed6eadc \
  --dest /etc/emisar/packs

# Reload so the runner re-reads the catalog:
sudo systemctl reload emisar

Actions 37 total

View on GitHub

pfsense.aliases script low

GET /api/v2/firewall/aliases
pfsense.apply_filter script medium

POST /api/v2/firewall/apply
pfsense.arp_table script low

GET /api/v2/diagnostics/arp_table
pfsense.auth_log script low

GET /api/v2/status/logs/auth
pfsense.carp_status script low

GET /api/v2/status/carp
pfsense.certificate_authorities script low

GET /api/v2/system/certificate_authorities
pfsense.certificates script low

GET /api/v2/system/certificates
pfsense.config_history script low

GET /api/v2/diagnostics/config_history/revisions
pfsense.crls script low

GET /api/v2/system/crls
pfsense.dhcp_leases script low

GET /api/v2/status/dhcp_server/leases
pfsense.dhcp_log script low

GET /api/v2/status/logs/dhcp
pfsense.firewall_log script low

GET /api/v2/status/logs/firewall
pfsense.firewall_rules script low

GET /api/v2/firewall/rules
pfsense.flush_states script high

DELETE /api/v2/firewall/states
pfsense.gateway_groups script low

GET /api/v2/routing/gateway/groups
pfsense.gateway_status script low

GET /api/v2/status/gateways
pfsense.gateways script low

GET /api/v2/routing/gateways
pfsense.interface_config script low

GET /api/v2/interfaces
pfsense.interface_status script low

GET /api/v2/status/interfaces
pfsense.ipsec_child_sas script low

GET /api/v2/status/ipsec/child_sas
pfsense.ipsec_status script low

GET /api/v2/status/ipsec/sas
pfsense.nat_outbound script low

GET /api/v2/firewall/nat/outbound/mappings
pfsense.nat_port_forwards script low

GET /api/v2/firewall/nat/port_forwards
pfsense.openvpn_log script low

GET /api/v2/status/logs/openvpn
pfsense.openvpn_status script low

GET /api/v2/status/openvpn/servers
pfsense.pf_table script low

GET /api/v2/diagnostics/table
pfsense.pf_tables script low

GET /api/v2/diagnostics/tables
pfsense.reboot script critical

POST /api/v2/diagnostics/reboot
pfsense.restart_service script high

POST /api/v2/status/service (restart)
pfsense.service_status script low

GET /api/v2/status/services
pfsense.states_size script low

GET /api/v2/firewall/states/size
pfsense.static_routes script low

GET /api/v2/routing/static_routes
pfsense.system_log script low

GET /api/v2/status/logs/system
pfsense.system_packages script low

GET /api/v2/system/packages
pfsense.system_status script low

GET /api/v2/status/system
pfsense.version script low

GET /api/v2/system/version
pfsense.virtual_ips script low

GET /api/v2/firewall/virtual_ips

← Back to registry

Pack reference Publish your own →