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

Weidmüller Consumer API

A consumer may - list/get available providers - list/get/update variables published by providers.

Weidmüller Consumer 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 Consumer. 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 14 schemas. It is described by OpenAPI 3.2.0, at version 1.3.0.

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

5 operations 3 paths 14 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3.0
Server
/u-os-hub/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

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

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

Paths & Operations 5

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

Consumer 5

A consumer may - list/get available providers - list/get/update variables published by providers.

GET
/providers
List providers
get_providers_handler → 200default
GET
/providers/{provider_id}/variables
List variable values of a single provider
get_variables_handler 3 params → 200default
POST
/providers/{provider_id}/variables
Update variable values of a single provider
post_multiple_variables_handler 1 param body → 200400405default
GET
/providers/{provider_id}/variables/{variable_key}
Get variable value of a single provider
get_single_variable_handler 3 params → 200default
POST
/providers/{provider_id}/variables/{variable_key}
Update variable value of a single provider
post_single_variable_handler 2 params body → 200400405default

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ResponseSingleRead (5 properties), VariableDefinition (3 properties), VariableUpdatePostPayload (2 properties), ResponseSingleProvider (1 property). Each schema is shown below with its type and property counts.

VariableDefinition
object
3 properties 2 required
VariableUpdatePostPayload
object
The JSON payload of a POST request (to update a single variable) is deserialized into this struct.
2 properties 2 required
ISO8601Duration
string
A duration string according to ISO8601 norm (https://datatracker.ietf.org/doc/html/rfc3339appendix-A). Example: 'PT5H9M39.400S'
VariableName
string
String that contains the key of a variable.
ProviderName
string
The id of a provider.
VariableValue
VariableAccessType
string
ResponseSingleRead
object
Response object for a single variable.
5 properties 4 required
Prefixes
string
A comma-separated list of prefixes used for listing a subset of variables.
ResponseSingleProvider
object
Response containing a single provider.
1 property 1 required
VariableQuality
string
FormatlessString
string
String without special format.
VariableDataType
string
ISO8601Timestamp
string
A timestamp string according to ISO8601 norm (https://datatracker.ietf.org/doc/html/rfc3339section-5.6). Example: '1970-01-01T00:20:34.000Z'

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weidmueller-consumer-api-openapi.yml Raw ↑

Other APIs Weidmüller publishes across the network.

Weidmüller u-OS Data Hub Variable-NATS API
Weidmüller Firewall API
Weidmüller Logging API
Weidmüller Network API
Weidmüller Operations API
Weidmüller Ping API
Weidmüller Realtime API
Weidmüller Recovery API
Weidmüller Security API
Weidmüller Serial Interfaces API
Weidmüller Syslog API
Weidmüller System API
Where this information came from

This is an independent, third-party profile of Weidmüller Consumer 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.