How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
pfSense

pfSense Firewall Aliases API

Manage firewall aliases.

Documentation Provider Profile APIs.io OpenAPI GitHub

pfSense Firewall Aliases API is one of 5 APIs that pfSense publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Firewall Aliases. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://{pfSenseHost}/api/v2.

5 operations 2 paths 1 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://pfsense.local/api/v2
Authentication
HTTP Basic, API Key, HTTP Bearer
Contact
pfSense REST API documentation
License
Apache 2.0
Resource Areas
1

Authentication & Security 3

pfSense Firewall Aliases API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-API-Key (apiKeyAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic auth with a pfSense local database username and password.
  • apiKeyAuth — API key generated through the webConfigurator or API endpoints. Keys inherit the permissions of the user that issued them.
  • bearerAuth — JWT bearer token obtained from POST /api/v2/auth/jwt. Tokens default to one hour of validity.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Firewall Aliases 5

Manage firewall aliases.

GET
/firewall/aliases
List firewall aliases
listFirewallAliases 4 params → 200
GET
/firewall/alias
Get a single firewall alias
getFirewallAlias 1 param → 200
POST
/firewall/alias
Create a firewall alias
createFirewallAlias body → 200
PATCH
/firewall/alias
Update a firewall alias
patchFirewallAlias body → 200
DELETE
/firewall/alias
Delete a firewall alias
deleteFirewallAlias 1 param → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is FirewallAlias (6 properties). Each schema is shown below with its type and property counts.

FirewallAlias
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pfsense-firewall-aliases-api-openapi.yml Raw ↑

Other APIs pfSense publishes across the network.

pfSense REST API (pfSense-pkg-RESTAPI)
AE Profile APIs.io
pfSense Authentication API
AE Profile APIs.io
pfSense Firewall Apply API
AE Profile APIs.io
pfSense Firewall Rules API
AE Profile APIs.io
#Firewall Aliases
← Back to P APIs
API Details
ID
pfsense:pfsense-firewall-aliases-api
Base URL
https://pfsense.local/api/v2
Docs
https://pfrest.org/
Provider
pfSense
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pfsense-firewall-aliases-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pfsense-firewall-aliases-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of pfSense Firewall Aliases API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.