pfSense

pfSense REST API (pfSense-pkg-RESTAPI)

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.

GitHub

Documentation

📖
Documentation
https://pfrest.org/

Other Resources

🔗
API Documentation
https://pfrest.org/api-docs/
🔗
GitHub Repository
https://github.com/jaredhendrickson13/pfsense-api
🔗
Contributing
https://pfrest.org/CONTRIBUTING/

API entry from apis.yml

apis.yml Raw ↑ 
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: GitHub Repository
  url: https://github.com/jaredhendrickson13/pfsense-api
- type: Contributing
  url: https://pfrest.org/CONTRIBUTING/