OutboundProtocolConfigInput
Input for outbound protocol configuration
Fields
Protocol type (required)
Possible values (4)
HTTPHTTP REST API
SQLSQL database connection
MQTTMQTT publish
JMFJMF (Job Messaging Format)
User-defined label
URL for HTTP/JMF protocols, or file path for SQLite adapter
Authentication mode
Possible values (3)
NONENo authentication
BASICHTTP Basic authentication
BEARERHTTP Bearer token authentication
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.
Username for authentication
Password (write-only, encrypted at rest). Never returned; omitting it leaves the stored password unchanged rather than clearing it.
Database adapter for SQL protocol
Possible values (5)
MSSQLMicrosoft SQL Server
MYSQLMySQL
POSTGRESQLPostgreSQL
SQLITESQLite (file-based)
ORACLEOracle
Host for SQL protocol
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.
Topic for MQTT protocol
Referenced by (3)
Exact type 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 @sensitive @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 @sensitive @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 @sensitive @iac_writeOnly(presence: "hasCredentials", updatedAt: "credentialsUpdatedAt")
"""Topic for MQTT protocol"""
topic: String
}