← API reference
CANONICAL TYPE REFERENCE

OutboundProtocolConfigInput

Input for outbound protocol configuration

Protocol type (required)

labelString

User-defined label

urlString

URL for HTTP/JMF protocols, or file path for SQLite adapter

Authentication mode

Authorization scheme for bearer auth; defaults to Bearer. Empty sends the token without a prefix.

Bearer token (write-only, encrypted at rest). Blank or omitted preserves the stored token while BEARER remains selected. Switching auth mode removes it.

usernameString

Username for authentication

passwordString

Password (write-only, encrypted at rest). Never returned; omitting it leaves the stored password unchanged rather than clearing it.

Database adapter for SQL protocol

hostString

Host for SQL protocol

portInt

Port for SQL protocol

Database name for SQL protocol

Connection string (write-only, encrypted at rest). Never returned; omitting it leaves the stored value unchanged rather than clearing it.

topicString

Topic for MQTT protocol

View exact SDL
"""Input for outbound protocol configuration"""
input OutboundProtocolConfigInput {
  """Protocol type (required)"""
  kind: OutboundProtocol!
  """User-defined label"""
  label: String
  """URL for HTTP/JMF protocols, or file path for SQLite adapter"""
  url: String
  """Authentication mode"""
  authMode: AuthMode
  """
  Authorization scheme for bearer auth; defaults to Bearer. Empty sends the token without a prefix.
  """
  bearerPrefix: String
  """
  Bearer token (write-only, encrypted at rest). Blank or omitted preserves the stored token while BEARER remains selected. Switching auth mode removes it.
  """
  bearerToken: String @iac_writeOnly(presence: "hasCredentials", updatedAt: "credentialsUpdatedAt")
  """Username for authentication"""
  username: String
  """
  Password (write-only, encrypted at rest). Never returned; omitting it leaves the stored password unchanged rather than clearing it.
  """
  password: String @iac_writeOnly(presence: "hasCredentials", updatedAt: "credentialsUpdatedAt")
  """Database adapter for SQL protocol"""
  adapter: DatabaseAdapter
  """Host for SQL protocol"""
  host: String
  """Port for SQL protocol"""
  port: Int
  """Database name for SQL protocol"""
  databaseName: String
  """
  Connection string (write-only, encrypted at rest). Never returned; omitting it leaves the stored value unchanged rather than clearing it.
  """
  connectionString: String @iac_writeOnly(presence: "hasCredentials", updatedAt: "credentialsUpdatedAt")
  """Topic for MQTT protocol"""
  topic: String
}

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