generated: '2026-10-09'
method: derived
generator: derive-data-model.py
source:
- openapi/weidmueller-administration-openapi.yml
- openapi/weidmueller-variable-http-openapi.yml
notation: has_one = property $ref; has_many = array of $ref; belongs_to = <entity>_id field
summary:
  entities: 125
  entities_in_spec: 125
  relationships: 59
entities:
- name: AddressInformation
  fields: 4
  description: Contains the address information of the device. Part of the device nameplate.
- name: CanInterfaceConfig
  fields: 1
- name: CanInterfaceState
  fields: 3
- name: CertificateEntry
  fields: 1
  description: A single certificate entry.
- name: Certificates
  fields: 3
  description: All certificates organized by type.
- name: CpuIsolationConfig
  fields: 1
- name: CpuIsolationState
  fields: 2
- name: CreateLogReportResponse
  fields: 1
- name: DeviceNameplate
  fields: 10
  description: Contains the device nameplate information.
- name: DhcpIpv4Range
  fields: 2
  description: Represents a range of IPv4 addresses
- name: Disk
  fields: 6
- name: Disks
  fields: 1
- name: DnatActionForward
  fields: 3
  description: Forward to another host/port.
- name: DnatActionRedirect
  fields: 2
  description: Redirect to the firewall host itself
- name: FailoverGlobalConfig
  fields: 3
  description: Global failover configuration.
- name: FailoverInterfaceConfig
  fields: 3
  description: Failover configuration for a single monitored interface.
- name: FilterRules
  fields: 4
- name: FirewallConfig
  fields: 2
  description: Custom firewall configuration. Contains filter and nat rules.
- name: Firmware
  fields: 2
- name: ForwardMatch
  fields: 0
- name: ForwardRule
  fields: 4
- name: GlobalDnsServers
  fields: 2
  description: Represents the global DNS servers used by the system.
- name: GpgKey
  fields: 1
  description: The content of a GPG public key file in ASCII armor format.
- name: HttpErrorPayload
  fields: 5
  description: Common error payload structure for HTTP responses.
- name: InboundMatch
  fields: 0
- name: InputRule
  fields: 4
- name: InterfaceConfig
  fields: 2
  description: Represents the configuration of a single network interface.
- name: InterfaceFailoverState
  fields: 3
  description: Failover state of a single interface exposed via the network state endpoint.
- name: InterfacePolicy
  fields: 3
  description: Specifies the default action for packets that do not match any rule on a specific interface.
- name: InterfaceState
  fields: 3
  description: Represents the current state of a network interface.
- name: Ipv4Config
  fields: 7
  description: Represents the IPv4 configuration of a network interface.
- name: Ipv4Route
  fields: 4
  description: An IP route entry in the IPv4 routing table.
- name: Ipv4State
  fields: 2
  description: Represents the IPv4 state of a network interface.
- name: Ipv4Subnet
  fields: 2
  description: Ipv4 address with prefix length.
- name: ListTimezonesResponse
  fields: 1
- name: LogEntry
  fields: 3
- name: LogEntryResponse
  fields: 2
- name: LogSource
  fields: 1
- name: LogSourcesResponse
  fields: 1
- name: ManualTimeSettings
  fields: 2
  description: Manual time settings used when `method` is `MANUAL`.
- name: MasqueradeAction
  fields: 1
  description: The source address is replaced depending on the routing destination
- name: Memory
  fields: 2
- name: NatRules
  fields: 2
- name: NetworkConfig
  fields: 4
  description: Used for writing the network configuration. All fields are required to be present, but can be empty
    in some cases.
- name: NetworkState
  fields: 3
  description: The current network state on the device.
- name: NtpRuntimeState
  fields: 3
- name: NtpSettings
  fields: 2
  description: NTP-specific settings used when `method` is `NTP`.
- name: OperationStateCompleted
  fields: 5
- name: OperationStateFailed
  fields: 4
- name: OperationStatePending
  fields: 2
- name: OutboundMatch
  fields: 0
- name: OutputRule
  fields: 4
- name: OutputState
  fields: 1
  description: Health information for a single syslog output.
- name: PartialCanInterfaceConfig
  fields: 1
- name: PartialCertificateEntry
  fields: 1
  description: A single certificate entry. (PATCH)
- name: PartialCertificates
  fields: 3
  description: All certificates organized by type.
- name: PartialDhcpIpv4Range
  fields: 2
  description: Represents a range of IPv4 addresses (PATCH)
- name: PartialDnatActionForward
  fields: 3
  description: Forward to another host/port. (PATCH)
- name: PartialDnatActionRedirect
  fields: 2
  description: Redirect to the firewall host itself (PATCH)
- name: PartialFailoverGlobalConfig
  fields: 3
  description: Global failover configuration.
- name: PartialFailoverInterfaceConfig
  fields: 3
  description: Failover configuration for a single monitored interface.
- name: PartialFilterRules
  fields: 4
- name: PartialFirewallConfig
  fields: 2
  description: Custom firewall configuration. Contains filter and nat rules.
- name: PartialForwardMatch
  fields: 0
- name: PartialForwardRule
  fields: 4
- name: PartialInboundMatch
  fields: 0
- name: PartialInputRule
  fields: 4
- name: PartialInterfaceConfig
  fields: 2
  description: Represents the configuration of a single network interface. (PATCH)
- name: PartialInterfacePolicy
  fields: 3
  description: Specifies the default action for packets that do not match any rule on a specific interface.
- name: PartialIpv4Config
  fields: 7
  description: Represents the IPv4 configuration of a network interface. (PATCH)
- name: PartialNatRules
  fields: 2
- name: PartialNetworkConfig
  fields: 4
  description: Used for writing the network configuration. All fields are required to be present, but can be empty
    in some cases. (PATCH)
- name: PartialOutboundMatch
  fields: 0
- name: PartialOutputRule
  fields: 4
- name: PartialPostroutingRule
  fields: 4
- name: PartialPreinstalledGpgKeysEnabled
  fields: 1
- name: PartialPreroutingRule
  fields: 4
- name: PartialRecipeSigning
  fields: 2
- name: PartialRemovableMediaUpdateConfig
  fields: 2
- name: PartialRs232Config
  fields: 1
- name: PartialRs485Config
  fields: 2
- name: PartialSerialInterfacesConfig
  fields: 2
  description: Configuration settings for all serial interfaces (CAN, RS-232, RS-485) on the system. (PATCH)
- name: PartialServiceInterfaceConfig
  fields: 1
  description: Represents the configuration of the service interface. (PATCH)
- name: PartialSharedModeConfig
  fields: 3
  description: Configuration options for interface sharing (PATCH)
- name: PartialSignedUpdateConfig
  fields: 3
- name: PartialSnatAction
  fields: 3
  description: Write a specific source address to the packet. (PATCH)
- name: PartialUpdateSettings
  fields: 2
  description: Represents the update configuration for the system used in get and put. (PATCH)
- name: PostroutingRule
  fields: 4
- name: PreinstalledGpgKeysEnabled
  fields: 1
- name: PreroutingRule
  fields: 4
- name: RealtimeConfig
  fields: 1
- name: RealtimeState
  fields: 1
- name: RecipeSigning
  fields: 2
- name: RemovableMediaUpdateConfig
  fields: 2
- name: ResponseSingleProvider
  fields: 1
  description: Response containing a single provider.
- name: ResponseSingleRead
  fields: 5
  description: Response object for a single variable.
- name: RootAccessConfig
  fields: 1
- name: Rs232Config
  fields: 1
  description: RS-232 mode configuration.
- name: Rs485Config
  fields: 2
  description: RS-485 mode configuration.
- name: RsInterfaceState
  fields: 4
- name: SecuritySettings
  fields: 1
- name: SerialInterfacesConfig
  fields: 2
  description: Configuration settings for all serial interfaces (CAN, RS-232, RS-485) on the system.
- name: SerialInterfacesState
  fields: 4
  description: Current state of all serial interfaces (CAN, RS-232, RS-485) on the system.
- name: ServerCaNoVerify
  fields: 1
  description: Do not verify the server's certificate (insecure, use only for testing).
- name: ServerCaVerify
  fields: 1
  description: Verify the server's certificate using the system's CA certificate store.
- name: ServerCaVerifyWithCa
  fields: 2
  description: Verify the server's certificate using a custom CA certificate.
- name: ServiceInterfaceConfig
  fields: 1
  description: Represents the configuration of the service interface.
- name: SharedModeConfig
  fields: 3
  description: Configuration options for interface sharing
- name: SignedUpdateConfig
  fields: 3
- name: SnatAction
  fields: 3
  description: Write a specific source address to the packet.
- name: SyslogConfig
  fields: 2
  description: Main configuration for syslog forwarding.
- name: SyslogDestination
  fields: 5
  description: Destination server configuration.
- name: SyslogFilter
  fields: 4
  description: Syslog filter criteria.
- name: SyslogOutputConfig
  fields: 2
  description: A single syslog output destination with its filter criteria.
- name: SyslogState
  fields: 2
  description: Runtime state of the syslog forwarding service.
- name: SystemInformation
  fields: 3
- name: TimeConfig
  fields: 2
  description: Time configuration for `GET /time/config` and `PUT /time/config`.
- name: TimeStateResponse
  fields: 2
- name: TimezoneItem
  fields: 3
  description: A single timezone entry with base and currently active seasonal offsets.
- name: TlsDisabled
  fields: 1
  description: TLS is disabled (plain-text transport).
- name: TlsEnabled
  fields: 2
  description: TLS is enabled with the given settings.
- name: TlsEnabledWithMtls
  fields: 4
- name: UpdateSettings
  fields: 2
  description: Represents the update configuration for the system used in get and put.
- name: VariableDefinition
  fields: 3
- name: VariableUpdatePostPayload
  fields: 2
  description: The JSON payload of a POST request (to update a single variable) is deserialized into this struct.
relationships:
- from: DeviceNameplate
  to: AddressInformation
  type: has_one
  via: AddressInformation
- from: Disks
  to: Disk
  type: has_many
  via: items
- from: FirewallConfig
  to: FilterRules
  type: has_one
  via: filter
- from: FirewallConfig
  to: NatRules
  type: has_one
  via: nat
- from: ForwardRule
  to: ForwardMatch
  type: has_one
  via: match
- from: InputRule
  to: InboundMatch
  type: has_one
  via: match
- from: InterfaceConfig
  to: Ipv4Config
  type: has_one
  via: ipv4_config
- from: InterfaceState
  to: InterfaceFailoverState
  type: has_one
  via: failover
- from: InterfaceState
  to: Ipv4State
  type: has_one
  via: ipv4
- from: Ipv4Config
  to: Ipv4Subnet
  type: has_many
  via: addresses
- from: Ipv4Config
  to: FailoverInterfaceConfig
  type: has_one
  via: failover
- from: Ipv4Config
  to: SharedModeConfig
  type: has_one
  via: shared_mode
- from: Ipv4Route
  to: Ipv4Subnet
  type: has_one
  via: destination
- from: Ipv4State
  to: Ipv4Subnet
  type: has_many
  via: addresses
- from: ListTimezonesResponse
  to: TimezoneItem
  type: has_many
  via: items
- from: LogEntry
  to: LogSource
  type: has_one
  via: source
- from: LogEntryResponse
  to: LogEntry
  type: has_many
  via: items
- from: LogSourcesResponse
  to: LogSource
  type: has_many
  via: items
- from: NetworkConfig
  to: FailoverGlobalConfig
  type: has_one
  via: failover
- from: NetworkConfig
  to: ServiceInterfaceConfig
  type: has_one
  via: service_interface
- from: NetworkState
  to: GlobalDnsServers
  type: has_one
  via: dns_resolver
- from: NetworkState
  to: Ipv4Route
  type: has_many
  via: routes
- from: OutputRule
  to: OutboundMatch
  type: has_one
  via: match
- from: PartialFirewallConfig
  to: PartialFilterRules
  type: has_one
  via: filter
- from: PartialFirewallConfig
  to: PartialNatRules
  type: has_one
  via: nat
- from: PartialForwardRule
  to: PartialForwardMatch
  type: has_one
  via: match
- from: PartialInputRule
  to: PartialInboundMatch
  type: has_one
  via: match
- from: PartialInterfaceConfig
  to: PartialIpv4Config
  type: has_one
  via: ipv4_config
- from: PartialIpv4Config
  to: Ipv4Subnet
  type: has_many
  via: addresses
- from: PartialIpv4Config
  to: PartialFailoverInterfaceConfig
  type: has_one
  via: failover
- from: PartialIpv4Config
  to: PartialSharedModeConfig
  type: has_one
  via: shared_mode
- from: PartialNetworkConfig
  to: PartialFailoverGlobalConfig
  type: has_one
  via: failover
- from: PartialNetworkConfig
  to: PartialServiceInterfaceConfig
  type: has_one
  via: service_interface
- from: PartialOutputRule
  to: PartialOutboundMatch
  type: has_one
  via: match
- from: PartialPostroutingRule
  to: PartialOutboundMatch
  type: has_one
  via: match
- from: PartialPreroutingRule
  to: PartialInboundMatch
  type: has_one
  via: match
- from: PartialRemovableMediaUpdateConfig
  to: PartialRecipeSigning
  type: has_one
  via: recipe_signing
- from: PartialSharedModeConfig
  to: PartialDhcpIpv4Range
  type: has_one
  via: dhcp_ip_range
- from: PartialSignedUpdateConfig
  to: PartialPreinstalledGpgKeysEnabled
  type: has_one
  via: preinstalled_gpg_keys
- from: PartialUpdateSettings
  to: PartialRemovableMediaUpdateConfig
  type: has_one
  via: removable_media_update
- from: PartialUpdateSettings
  to: PartialSignedUpdateConfig
  type: has_one
  via: signed_update
- from: PostroutingRule
  to: OutboundMatch
  type: has_one
  via: match
- from: PreroutingRule
  to: InboundMatch
  type: has_one
  via: match
- from: RealtimeConfig
  to: CpuIsolationConfig
  type: has_one
  via: cpu_isolation
- from: RealtimeState
  to: CpuIsolationState
  type: has_one
  via: cpu_isolation
- from: RemovableMediaUpdateConfig
  to: RecipeSigning
  type: has_one
  via: recipe_signing
- from: SecuritySettings
  to: RootAccessConfig
  type: has_one
  via: root_access
- from: SerialInterfacesState
  to: CanInterfaceState
  type: has_many
  via: can_interfaces
- from: SerialInterfacesState
  to: RsInterfaceState
  type: has_many
  via: rs_interfaces
- from: SharedModeConfig
  to: DhcpIpv4Range
  type: has_one
  via: dhcp_ip_range
- from: SignedUpdateConfig
  to: PreinstalledGpgKeysEnabled
  type: has_one
  via: preinstalled_gpg_keys
- from: SyslogOutputConfig
  to: SyslogDestination
  type: has_one
  via: destination
- from: SyslogOutputConfig
  to: SyslogFilter
  type: has_one
  via: filter
- from: SystemInformation
  to: Firmware
  type: has_one
  via: firmware
- from: SystemInformation
  to: Memory
  type: has_one
  via: memory
- from: TimeStateResponse
  to: NtpRuntimeState
  type: has_one
  via: ntp
- from: UpdateSettings
  to: RemovableMediaUpdateConfig
  type: has_one
  via: removable_media_update
- from: UpdateSettings
  to: SignedUpdateConfig
  type: has_one
  via: signed_update
- from: ResponseSingleRead
  to: VariableDefinition
  type: has_one
  via: definition