pfSense CLI Commands

Overview

The netapi pfsense command group provides access to pfSense firewalls via REST API v2.

Category	Description
DNS	DNS Resolver host override management
DHCP	DHCP server management
Firewall	Firewall rules and aliases
Interfaces	Interface configuration
Routing	Static routes and gateways
Logging	Remote syslog configuration

System Commands

# System info
netapi pfsense info

# Network interfaces
netapi pfsense interfaces

# ARP table
netapi pfsense arp

# DHCP leases
netapi pfsense leases

# Backup configuration
netapi pfsense backup /path/to/backup.xml

Certificate Operations

# List certificates
netapi pfsense cert list

# Get certificate details
netapi pfsense cert show <name>

Quick Reference

# Interfaces
netapi pfsense interfaces
netapi pfsense interface show lan

# DHCP
netapi pfsense dhcp show opt1
netapi pfsense dhcp leases

# Firewall
netapi pfsense firewall rules
netapi pfsense firewall aliases

# System
netapi pfsense info
netapi pfsense status

Environment Setup

# Via dsource
eval "$(dsource d000 dev/network)"

# Or manual
export PFSENSE_IP=10.50.1.1
export PFSENSE_API_SECRET='your-api-key'

API v2 Endpoints

Endpoint Description

Endpoint	Description
`/api/v2/system/info`	System information
`/api/v2/interface`	Interface configuration
`/api/v2/services/dhcp_server`	DHCP server settings
`/api/v2/firewall/rule`	Firewall rules
`/api/v2/firewall/alias`	Firewall aliases
`/api/v2/status/logs/settings`	Remote syslog configuration

/api/v2/system/info

System information

/api/v2/interface

Interface configuration

/api/v2/services/dhcp_server

DHCP server settings

/api/v2/firewall/rule

Firewall rules

/api/v2/firewall/alias

Firewall aliases

/api/v2/status/logs/settings

Remote syslog configuration