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

API for syslog forwarding configuration

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

This API exposes 6 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.

6 operations 3 paths 24 schemas 3 GET1 PATCH2 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 Syslog 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 6

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

Syslog 6

API for syslog forwarding configuration

GET
/syslog/certificates
Get all uploaded certificates
get_certificates → 200default
PUT
/syslog/certificates
Set all certificates
set_certificates body → 200400default
PATCH
/syslog/certificates
Partially update certificates
patch_certificates body → 200400default
GET
/syslog/config
Get syslog forwarding configuration
get_config → 200default
PUT
/syslog/config
Set syslog forwarding configuration
set_config body → 200400default
GET
/syslog/state
Get syslog forwarding service state
get_state → 200default

Schemas 24

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

OutputReachability
string
Reachability status of a syslog output destination.
ServiceStatus
string
Systemd service status.
HttpErrorPayload
object
Common error payload structure for HTTP responses. Based on [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457)
5 properties 3 required
ServerCaVerify
object
Verify the server's certificate using the system's CA certificate store.
1 property 1 required
ServerCaVerifyWithCa
object
Verify the server's certificate using a custom CA certificate. The CA certificate must be uploaded via PUT /syslog/certificates.
2 properties 2 required
TlsEnabled
object
TLS is enabled with the given settings.
2 properties 2 required
Certificates
object
All certificates organized by type. Each certificate type maps certificate names (keys) to their entries.
3 properties 3 required
SyslogLevel
string
Syslog severity levels as defined in RFC 5424.
TlsDisabled
object
TLS is disabled (plain-text transport).
1 property 1 required
SyslogOutputConfig
object
A single syslog output destination with its filter criteria. The output name (map key) must be 1-32 characters, containing only lowercase letters, numbers, and…
2 properties 2 required
SyslogDestination
object
Destination server configuration.
5 properties 5 required
TlsConfig
TLS configuration for encrypted syslog transport. Certificates are managed separately via the certificates endpoint.
ServerCa
Server certificate verification configuration.
SyslogFormat
string
Syslog message format standard.
Transport
string
Transport protocol for syslog. TLS is configured separately.
ServerCaNoVerify
object
Do not verify the server's certificate (insecure, use only for testing).
1 property 1 required
CertificateEntry
object
A single certificate entry.
1 property 1 required
SyslogState
object
Runtime state of the syslog forwarding service.
2 properties 1 required
SyslogFacility
string
Standard syslog facilities as defined in RFC 5424.
SyslogFilter
object
Syslog filter criteria. Filtering uses systemd journal's native logic: - Within a field: values are OR'd (e.g., level=err OR level=warning) - Across fields: co…
4 properties 4 required
PartialCertificates
object
All certificates organized by type. Each certificate type maps certificate names (keys) to their entries. (PATCH)
3 properties
SyslogConfig
object
Main configuration for syslog forwarding.
2 properties 2 required
TlsEnabledWithMtls
object
4 properties 4 required
OutputState
object
Health information for a single syslog output.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weidmueller-syslog-api-openapi.yml Raw ↑

Other APIs Weidmüller publishes across the network.

Weidmüller u-OS Data Hub Variable-NATS API
Weidmüller Consumer 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 System API
Where this information came from

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