← API reference
CANONICAL TYPE REFERENCE

UpdateEdgeAppInput

Input for updating a DRAFT edge app. Only provided fields are changed.

handleString

Wire id. Immutable on an existing draft — providing a different value than the current handle is rejected.

nameString

Display name

Optional human description

Triggers in this edgeApp; replaces the full list when provided

Handlers in this edgeApp; replaces the full list when provided

Reusable Lua snippets; replaces the full list when provided

External MQTT broker template shape; replaces the full list when provided (write-only secrets preserved per-broker by name when omitted)

External OPC UA endpoints; replaces the full list when provided (write-only secrets preserved per-endpoint by name when omitted)

External SNMP devices; replaces the full list when provided (write-only secrets preserved per-device by name when omitted)

Modbus ports; replaces the full list when provided

Exec commands; replaces the full list when provided

HTTP inbound routes; replaces the full list when provided (write-only auth credentials preserved per-route by method+path when the auth mode is unchanged)

onMessageString

Lua entry point script for local.edgeApp.invoke

Optional JSON Schema for installation variables

Cloud-forwarding level

isActiveBoolean

Whether this edgeApp is included in installation pushes

View exact SDL
"""Input for updating a DRAFT edge app. Only provided fields are changed."""
input UpdateEdgeAppInput {
  """
  Wire id. Immutable on an existing draft — providing a different value than the current handle is rejected.
  """
  handle: String
  """Display name"""
  name: String
  """Optional human description"""
  description: String
  """Triggers in this edgeApp; replaces the full list when provided"""
  triggers: [EdgeAppTriggerInput!]
  """Handlers in this edgeApp; replaces the full list when provided"""
  handlers: [EdgeAppHandlerInput!]
  """Reusable Lua snippets; replaces the full list when provided"""
  libraries: [EdgeAppLibraryInput!]
  """
  External MQTT broker template shape; replaces the full list when provided (write-only secrets preserved per-broker by name when omitted)
  """
  mqttBrokers: [EdgeAppMQTTBrokerInput!]
  """
  External OPC UA endpoints; replaces the full list when provided (write-only secrets preserved per-endpoint by name when omitted)
  """
  opcuaEndpoints: [EdgeAppOPCUAEndpointInput!]
  """
  External SNMP devices; replaces the full list when provided (write-only secrets preserved per-device by name when omitted)
  """
  snmpDevices: [EdgeAppSNMPDeviceInput!]
  """Modbus ports; replaces the full list when provided"""
  modbusPorts: [EdgeAppModbusPortInput!]
  """Exec commands; replaces the full list when provided"""
  execCommands: [EdgeAppExecCommandInput!]
  """
  HTTP inbound routes; replaces the full list when provided (write-only auth credentials preserved per-route by method+path when the auth mode is unchanged)
  """
  httpRoutes: [EdgeAppHTTPRouteInput!]
  """Lua entry point script for local.edgeApp.invoke"""
  onMessage: String
  """Optional JSON Schema for installation variables"""
  configSchema: JSON
  """Cloud-forwarding level"""
  logLevel: EdgeAppLogLevel
  """Whether this edgeApp is included in installation pushes"""
  isActive: Boolean
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.