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 Serial Interfaces API

API for u-OS serial interface settings

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 4 operations across 2 paths, and defines 11 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.

4 operations 2 paths 11 schemas 2 GET1 PATCH1 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 Serial Interfaces 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 4

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

serial-interfaces 4

API for u-OS serial interface settings

GET
/serial-interfaces/config
Read the serial interface configuration for the system
get_serial_interface_config → 200default
PUT
/serial-interfaces/config
Set the serial interface configuration for the system
set_serial_interface_config body → 200default
PATCH
/serial-interfaces/config
Update the serial interface configuration for the system
update_serial_interface_config body → 200default
GET
/serial-interfaces/state
Get the current state of the serial interfaces on the system
get_serial_interface_state → 200default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are HttpErrorPayload (5 properties), SerialInterfacesState (4 properties), RsInterfaceState (4 properties), CanInterfaceState (3 properties). Each schema is shown below with its type and property counts.

SerialInterfacesState
object
Current state of all serial interfaces (CAN, RS-232, RS-485) on the system. Unlike the configuration struct, this only contains interfaces that are currently p…
4 properties 4 required
AllowedRsMode
string
Represents the allowed operation modes for a RS interface. This determines which config variants are allowed for the interface. For example, some interfaces ma…
SerialInterfacesConfig
object
Configuration settings for all serial interfaces (CAN, RS-232, RS-485) on the system.
2 properties 2 required
PartialSerialInterfacesConfig
object
Configuration settings for all serial interfaces (CAN, RS-232, RS-485) on the system. (PATCH)
2 properties
RsInterfaceConfig
Current operation mode of a RS interface (RS-232 or RS-485). The mode field is the discriminator selecting the variant. For RS-485 interfaces, this also includ…
Rs232Config
object
RS-232 mode configuration.
1 property 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
CanInterfaceState
object
3 properties 3 required
CanInterfaceConfig
object
1 property 1 required
Rs485Config
object
RS-485 mode configuration.
2 properties 2 required
RsInterfaceState
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weidmueller-serial-interfaces-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 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 Syslog API
AE Profile APIs.io
Weidmüller System API
AE Profile APIs.io
#serial-interfaces
← Back to W APIs
API Details
ID
weidmueller:weidmueller-serial-interfaces-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-serial-interfaces-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/weidmueller-serial-interfaces-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 Serial Interfaces 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.