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
Weidmüller

Weidmüller Firewall API

API for firewall settings of u-OS

Documentation Provider Profile APIs.io OpenAPI GitHub

Weidmüller Firewall API is one of 16 APIs that Weidmüller publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Firewall. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 5 JSON Schemas.

This API exposes 8 operations across 3 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.5.0-next.

Requests are made against a single base URL, /u-os-adm/api/v1.

8 operations 3 paths 24 schemas 2 GET1 HEAD2 PATCH1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.5.0-next
Server
/u-os-adm/api/v1
Authentication
OAuth 2.0
Contact
Weidmüller
License
MIT
Resource Areas
1

Authentication & Security 1

Weidmüller Firewall API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow, exposing 20 scopes.

  • OAuth2 — The HTTP API uses the OAuth2 client credentials flow.

Paths & Operations 8

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

Firewall 8

API for firewall settings of u-OS

GET
/firewall/active-config
Get the currently active firewall configuration
get_firewall_active_config → 200default
PUT
/firewall/active-config
Set a temporary override on the active firewall configuration
set_firewall_active_config 2 params body → 200default
HEAD
/firewall/active-config
Check active firewall configuration metadata.
head_firewall_active_config → 200default
PATCH
/firewall/active-config
Modify the active firewall configuration with a temporary override
update_firewall_active_config 2 params body → 200default
GET
/firewall/config
Get the persistent firewall configuration
get_firewall_config → 200default
PUT
/firewall/config
Set the persistent firewall configuration
set_firewall_config 1 param body → 200default
PATCH
/firewall/config
Modify the persistent firewall configuration
update_firewall_config 1 param body → 200default
POST
/firewall:reload
Reloads the firewall configuration, which deletes the temporary config and…
reload_firewall_config → 200default

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are HttpErrorPayload (5 properties), InputRule (4 properties), OutputRule (4 properties), ForwardRule (4 properties). Each schema is shown below with its type and property counts.

PartialFirewallConfig
object
Custom firewall configuration. Contains filter and nat rules. If an array is empty, it means "match all". For example, an InputRule with an empty source matche…
2 properties
PostroutingRule
object
4 properties 4 required
HttpErrorPayload
object
Common error payload structure for HTTP responses. Based on [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457)
5 properties 3 required
NatRules
object
2 properties 2 required
InterfacePolicy
object
Specifies the default action for packets that do not match any rule on a specific interface. This allows you to configure whether the rules are an allowlist or…
3 properties 3 required
PartialNatRules
object
2 properties
InboundMatch
PartialFilterRules
object
4 properties
OutboundMatch
ForwardMatch
PolicyType
string
OSDefault - All custom firewall rules will be ignored! Uses the default policy and firewall rules of u-OS. Currently, this means input=Accept, output=Accept, f…
PostroutingAction
Specifies the action to take for packets that match a postrouting rule. Masquerade replaces the source address with the outgoing interface's IP address. Snat r…
PreroutingRule
object
4 properties 4 required
DnatAction
MasqueradeAction
object
The source address is replaced depending on the routing destination (e.g. with the outgoing interface's IP address).
1 property 1 required
SnatAction
object
Write a specific source address to the packet.
3 properties 2 required
ForwardRule
object
4 properties 4 required
OutputRule
object
4 properties 4 required
FirewallConfig
object
Custom firewall configuration. Contains filter and nat rules. If an array is empty, it means "match all". For example, an InputRule with an empty source matche…
2 properties 2 required
RuleAction
string
Specifies if the matching packets should be dropped, accepted. If a packet is accepted or dropped, no further rules are evaluated for that packet. You can use…
DnatActionRedirect
object
Redirect to the firewall host itself
2 properties 2 required
DnatActionForward
object
Forward to another host/port.
3 properties 2 required
InputRule
object
4 properties 4 required
FilterRules
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weidmueller-firewall-api-openapi.yml Raw ↑

Other APIs Weidmüller publishes across the network.

Weidmüller u-OS Data Hub Variable-NATS API
AE Profile APIs.io
Weidmüller Consumer API
AE Profile APIs.io
Weidmüller Logging API
AE Profile APIs.io
Weidmüller Network API
AE Profile APIs.io
Weidmüller Operations API
AE Profile APIs.io
Weidmüller Ping API
AE Profile APIs.io
Weidmüller Realtime API
AE Profile APIs.io
Weidmüller Recovery API
AE Profile APIs.io
Weidmüller Security API
AE Profile APIs.io
Weidmüller Serial Interfaces API
AE Profile APIs.io
Weidmüller Syslog API
AE Profile APIs.io
Weidmüller System API
AE Profile APIs.io
#Firewall
← Back to W APIs
API Details
ID
weidmueller:weidmueller-firewall-api
Server
/u-os-adm/api/v1
Docs
https://github.com/weidmueller/u-os-hub-api/tree/main/openapi
Provider
Weidmüller
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=weidmueller-firewall-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/weidmueller-firewall-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 Weidmüller Firewall 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.