Resource
device
An IoT device
Configuration
networkIdNetworkIDOptionalAssociated network ID
References network
controllerIdControllerIDOptionalExclusive controller binding on this network. Update omission preserves it; upsert omission clears it.
References controller
identifierString!RequiredUnique device identifier (required)
forces replacement
nameStringOptionalDisplay name
descriptionStringOptionalDevice description
deviceTypeStringOptionalType of device
manufacturerStringOptionalDevice manufacturer
modelStringOptionalDevice model
serialNumberStringOptionalDevice serial number
outboundProtocols[OutboundProtocolConfig!]!OptionalOutbound protocol configurations
inboundProtocols[InboundProtocolConfig!]!OptionalInbound protocol configurations
isActiveBoolean!OptionalWhether the device is active
Input types
Fields for the structured values used in this resource’s configuration.
OutboundProtocolConfigInput
Input for outbound protocol configuration
kindOutboundProtocol!RequiredProtocol type (required)
Allowed values
HTTP — HTTP REST API
SQL — SQL database connection
MQTT — MQTT publish
JMF — JMF (Job Messaging Format)
labelStringOptionalUser-defined label
urlStringOptionalURL for HTTP/JMF protocols, or file path for SQLite adapter
authModeAuthModeOptionalAuthentication mode
Allowed values
NONE — No authentication
BASIC — HTTP Basic authentication
BEARER — HTTP Bearer token authentication
bearerPrefixStringOptionalAuthorization scheme for bearer auth; defaults to Bearer. Empty sends the token without a prefix.
bearerTokenStringOptionalBearer token (write-only, encrypted at rest). Blank or omitted preserves the stored token while BEARER remains selected. Switching auth mode removes it.
usernameStringOptionalUsername for authentication
passwordStringOptionalPassword (write-only, encrypted at rest). Never returned; omitting it leaves the stored password unchanged rather than clearing it.
adapterDatabaseAdapterOptionalDatabase adapter for SQL protocol
Allowed values
MSSQL — Microsoft SQL Server
MYSQL — MySQL
POSTGRESQL — PostgreSQL
SQLITE — SQLite (file-based)
ORACLE — Oracle
hostStringOptionalHost for SQL protocol
portIntOptionalPort for SQL protocol
databaseNameStringOptionalDatabase name for SQL protocol
connectionStringStringOptionalConnection string (write-only, encrypted at rest). Never returned; omitting it leaves the stored value unchanged rather than clearing it.
topicStringOptionalTopic for MQTT protocol
InboundProtocolConfigInput
Input for inbound protocol configuration
kindInboundProtocol!RequiredProtocol type (required)
Allowed values
MQTT — MQTT subscription
HTTP — HTTP webhook receiver
labelStringOptionalUser-defined label
topicStringOptionalTopic for MQTT protocol
webhookPathStringOptionalPath for HTTP webhook
Read-only values
Lifecycle
The CLI can create this resource. The platform assigns its id.
When replacement is needed, the existing resource is removed before its replacement is created.