pfSense

aid: pfsense
name: pfSense
description: pfSense is an open-source firewall and router operating system based on FreeBSD, developed and maintained by
  Netgate, providing stateful firewall, routing, VPN (IPsec, OpenVPN, WireGuard), captive portal, traffic shaping, and IDS/IPS
  capabilities for home and enterprise networks. It is available as pfSense Community Edition (CE) and pfSense Plus, both
  managed via a web UI. The unofficial pfSense-pkg-RESTAPI package adds a REST and GraphQL API with 200+ endpoints under /api/v2
  for automating firewall management, authenticated via local users, API keys, or JWT.
type: Index
deliveryModel:
  model: open-core
  license: Apache-2.0
  open_source: true
  commercial: true
  callable_host: false
  label: Open core · an OSS project plus a commercial hosted product
  confidence: high
  source:
  - license
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: unknown
  onboarding: unknown
  trial: false
  try_now: false
  public: false
  label: Unknown
  confidence: low
  source:
  - authentication
  - security
  generated: '2026-09-03'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/pfsense.png
tags:
- Firewall
- Network Security
- Router
- VPN
- Open-Source
- FreeBSD
- Netgate
tags_raw:
- Firewall
- Network Security
- Router
- VPN
- Open Source
- FreeBSD
- Netgate
url: https://raw.githubusercontent.com/api-evangelist/pfsense/refs/heads/main/apis.yml
created: '2026-05-11'
modified: '2026-05-11'
specificationVersion: '0.23'
apis:
- aid: pfsense:rest-api-package
  name: pfSense REST API (pfSense-pkg-RESTAPI)
  description: Community-maintained REST and GraphQL API package for pfSense CE and pfSense Plus exposing 200+ endpoints under
    /api/v2 for firewall, interface, service, user, and system management. Authentication supports local user credentials,
    API keys, and JWT bearer tokens; the base URL is the pfSense instance's own hostname.
  humanURL: https://pfrest.org/
  baseURL: https://pfsense.local/api/v2
  tags:
  - Firewall API
  - Network Automation
  - REST
  - GraphQL
  properties:
  - type: Documentation
    url: https://pfrest.org/
  - type: API Documentation
    url: https://pfrest.org/api-docs/
  - type: GitHubRepository
    url: https://github.com/jaredhendrickson13/pfsense-api
  - type: Contributing
    url: https://pfrest.org/CONTRIBUTING/
  - url: graphql/pfsense-graphql.md
    type: GraphQL
- aid: pfsense:pfsense-authentication-api
  name: pfSense Authentication API
  description: Obtain JWT bearer tokens.
  humanURL: https://pfrest.org/
  baseURL: https://pfsense.local/api/v2
  tags:
  - Authentication
  properties:
  - type: OpenAPI
    url: openapi/pfsense-authentication-api-openapi.yml
- aid: pfsense:pfsense-firewall-aliases-api
  name: pfSense Firewall Aliases API
  description: Manage firewall aliases.
  humanURL: https://pfrest.org/
  baseURL: https://pfsense.local/api/v2
  tags:
  - Firewall Aliases
  properties:
  - type: OpenAPI
    url: openapi/pfsense-firewall-aliases-api-openapi.yml
- aid: pfsense:pfsense-firewall-apply-api
  name: pfSense Firewall Apply API
  description: Apply pending firewall changes.
  humanURL: https://pfrest.org/
  baseURL: https://pfsense.local/api/v2
  tags:
  - Firewall Apply
  properties:
  - type: OpenAPI
    url: openapi/pfsense-firewall-apply-api-openapi.yml
- aid: pfsense:pfsense-firewall-rules-api
  name: pfSense Firewall Rules API
  description: Manage firewall rules.
  humanURL: https://pfrest.org/
  baseURL: https://pfsense.local/api/v2
  tags:
  - Firewall Rules
  properties:
  - type: OpenAPI
    url: openapi/pfsense-firewall-rules-api-openapi.yml
common:
- type: IssueTracker
  url: https://github.com/jaredhendrickson13/pfsense-api/issues
- type: Releases
  url: https://github.com/jaredhendrickson13/pfsense-api/releases
- type: ContributionGuide
  url: https://github.com/pfrest/pfSense-pkg-RESTAPI/blob/master/docs/CONTRIBUTING.md
- type: License
  name: Apache-2.0
  url: https://github.com/jaredhendrickson13/pfsense-api/blob/master/LICENSE
- type: AgenticAccess
  url: agentic-access/pfsense-agentic-access.yml
- type: VulnerabilityDisclosure
  url: security/pfsense-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/pfsense-domain-security.yml
- type: Authentication
  url: authentication/pfsense-authentication.yml
- type: Website
  url: https://www.pfsense.org/
- type: Documentation
  url: https://docs.netgate.com/pfsense/en/latest/
- type: Pricing
  url: https://www.netgate.com/pfsense-plus-software
- type: Download
  url: https://www.pfsense.org/download/
- type: GitHubOrganization
  url: https://github.com/pfsense
- type: Vendor
  url: https://www.netgate.com/
- url: https://www.netgate.com/blog/rss.xml
  type: Blog
features:
- name: Stateful Firewall
  description: pf-based stateful packet filtering with aliases, schedules, and floating rules for granular network policy.
- name: VPN Services
  description: Built-in IPsec, OpenVPN, and WireGuard VPN servers and clients for site-to-site and remote access connectivity.
- name: Routing and NAT
  description: Static and dynamic routing (FRR, BGP, OSPF via packages) plus full NAT/PAT/1:1 mapping configuration.
- name: Traffic Shaping and QoS
  description: Limiters and HFSC/CBQ/PRIQ queues to prioritize traffic and enforce bandwidth policies per host or service.
- name: IDS/IPS
  description: Snort and Suricata packages for intrusion detection and prevention, with rule subscriptions and per-interface
    configuration.
- name: REST/GraphQL API
  description: Optional pfSense-pkg-RESTAPI package providing programmatic configuration of nearly all pfSense subsystems.
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com