OutboundProtocolConfig
Outbound protocol configuration (secrets excluded)
Fields
Protocol type
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.
Username for authentication
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
Topic for MQTT protocol
Whether a password, bearer token or connection string is stored for this protocol. The secrets themselves are never returned. Reported per protocol, not per field: a SQL protocol may hold both a password and a connection string, and this is true when either is. It cannot tell you which — if you need that, the protocol's own shape (host set vs connectionString set) is the better signal.
When the stored secret last changed (ISO8601), or null if none is set — also null for a credential last written before the platform recorded this. Says when, never what. Per protocol, like hasCredentials: where a protocol holds both a password and a connection string, changing either moves this, so it answers 'this protocol's credentials changed' rather than naming which one.
Referenced by (1)
Exact type SDL
"""Outbound protocol configuration (secrets excluded)"""
type OutboundProtocolConfig {
"""Protocol type"""
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
"""Username for authentication"""
username: String
"""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
"""Topic for MQTT protocol"""
topic: String
"""
Whether a password, bearer token or connection string is stored for this protocol. The secrets themselves are never returned. Reported per **protocol**, not per field: a SQL protocol may hold both a password and a connection string, and this is true when either is. It cannot tell you which — if you need that, the protocol's own shape (host set vs connectionString set) is the better signal.
"""
hasCredentials: Boolean! @iac_computed
"""
When the stored secret last changed (ISO8601), or null if none is set — also null for a credential last written before the platform recorded this. Says when, never what. Per protocol, like hasCredentials: where a protocol holds both a password and a connection string, changing either moves this, so it answers 'this protocol's credentials changed' rather than naming which one.
"""
credentialsUpdatedAt: String @iac_computed
}