# pfSense REST API (pfSense-pkg-RESTAPI)

**Canonical:** https://apis.io/apis/pfsense/rest-api-package/  
**Provider:** pfSense — https://apis.io/providers/pfsense/  
**Base URL:** https://pfsense.local/api/v2  
**Documentation:** https://pfrest.org/

pfSense REST API (pfSense-pkg-RESTAPI) is one of 5 APIs that [pfSense](https://apis.io/providers/pfsense/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Firewall API, Network Automation, REST, and GraphQL. The published artifact set on APIs.io includes API documentation and a GitHub repository.

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.

## Machine-readable artifacts (6)

- **Documentation** — https://pfrest.org/
- **API Documentation** — https://pfrest.org/api-docs/
- **GitHubRepository** — https://github.com/jaredhendrickson13/pfsense-api
- **Contributing** — https://pfrest.org/CONTRIBUTING/
- **GraphQL** — https://raw.githubusercontent.com/api-evangelist/pfsense/refs/heads/main/graphql/pfsense-graphql.md
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/pfsense/refs/heads/main/apis.yml

## Other pfSense APIs (4)

- [pfSense Authentication API](https://apis.io/apis/pfsense/pfsense-authentication-api/)
- [pfSense Firewall Aliases API](https://apis.io/apis/pfsense/pfsense-firewall-aliases-api/)
- [pfSense Firewall Apply API](https://apis.io/apis/pfsense/pfsense-firewall-apply-api/)
- [pfSense Firewall Rules API](https://apis.io/apis/pfsense/pfsense-firewall-rules-api/)

## Tags

Firewall API, Network Automation, REST, GraphQL

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pfsense/rest-api-package/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pfsense/.