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 Network API

API for network settings and state of u-OS

Documentation Provider Profile APIs.io OpenAPI GitHub

Weidmüller Network 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 Networks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 5 JSON Schemas.

This API exposes 5 operations across 3 paths, and defines 29 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.

5 operations 3 paths 29 schemas 2 GET1 PATCH1 POST1 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 Network 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 5

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

Network 5

API for network settings and state of u-OS

GET
/network/config
Get the current network configuration of the device
get_network_config → 200default
PUT
/network/config
Set the full network configuration of the device
set_network_config body → 200default
PATCH
/network/config
Modify the network configuration of the device
update_network_config body → 200default
GET
/network/state
Get the current network state of the device
get_network_state → 200default
POST
/network:factory-reset
Triggers a network settings factory reset
network_factory_reset 1 param → 200default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Ipv4Config (7 properties), PartialIpv4Config (7 properties), HttpErrorPayload (5 properties), Ipv4Route (4 properties). Each schema is shown below with its type and property counts.

Ipv4Route
object
An IP route entry in the IPv4 routing table.
4 properties 4 required
PartialFailoverGlobalConfig
object
Global failover configuration. Controls the probe loop that monitors all configured interfaces and adjusts their route metrics based on connectivity probe resu…
3 properties
GlobalDnsServers
object
Represents the global DNS servers used by the system. The order of the servers represents their priority, with the first one being the primary DNS server unles…
2 properties 2 required
PartialDhcpIpv4Range
object
Represents a range of IPv4 addresses (PATCH)
2 properties
PartialInterfaceConfig
object
Represents the configuration of a single network interface. (PATCH)
2 properties
NetworkState
object
The current network state on the device. Note that this may differ from the configuration, e.g. a DHCP interface has an address in the state, but not in the co…
3 properties 3 required
SharedModeConfig
object
Configuration options for interface sharing
3 properties 1 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
Ipv4PrefixLength
integer
InterfaceFailoverState
object
Failover state of a single interface exposed via the network state endpoint.
3 properties 3 required
Ipv4String
string
Represents an IPv4 address in a string format.
InterfaceType
string
The type of network interface.
DhcpIpv4Range
object
Represents a range of IPv4 addresses
2 properties 2 required
Ipv4Subnet
object
Ipv4 address with prefix length. The prefix length is used to determine the network mask.
2 properties 2 required
PartialFailoverInterfaceConfig
object
Failover configuration for a single monitored interface. When enabled, the probe loop checks connectivity on this interface. If failurethreshold consecutive pr…
3 properties
ProbeTarget
string
IPv4 address or hostname used as the probe target, optionally with a port (e.g. "1.1.1.1:5000"). If no port is specified, port 443 is used. IPv4 addresses are…
PartialServiceInterfaceConfig
object
Represents the configuration of the service interface. (PATCH)
1 property
PartialSharedModeConfig
object
Configuration options for interface sharing (PATCH)
3 properties
ServiceInterfaceConfig
object
Represents the configuration of the service interface.
1 property 1 required
InterfaceProbeState
string
The current failover probe state of a monitored interface. - HEALTHY: Enabled and passing probes. - PROBING: Transitional state on the path to failure or recov…
FailoverInterfaceConfig
object
Failover configuration for a single monitored interface. When enabled, the probe loop checks connectivity on this interface. If failurethreshold consecutive pr…
3 properties 3 required
InterfaceConfig
object
Represents the configuration of a single network interface.
2 properties 1 required
Ipv4Config
object
Represents the IPv4 configuration of a network interface.
7 properties 4 required
InterfaceState
object
Represents the current state of a network interface.
3 properties 2 required
PartialNetworkConfig
object
Used for writing the network configuration. All fields are required to be present, but can be empty in some cases. (PATCH)
4 properties
NetworkConfig
object
Used for writing the network configuration. All fields are required to be present, but can be empty in some cases.
4 properties 2 required
PartialIpv4Config
object
Represents the IPv4 configuration of a network interface. (PATCH)
7 properties
FailoverGlobalConfig
object
Global failover configuration. Controls the probe loop that monitors all configured interfaces and adjusts their route metrics based on connectivity probe resu…
3 properties 3 required
Ipv4State
object
Represents the IPv4 state of a network interface.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weidmueller-network-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 Firewall API
AE Profile APIs.io
Weidmüller Logging 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
#Networks
← Back to W APIs
API Details
ID
weidmueller:weidmueller-network-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-network-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/weidmueller-network-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 Network 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.