← All resources

Resource

device

An IoT device

GraphQL reference →

Configuration

networkIdNetworkIDOptional

Associated network ID

References network

controllerIdControllerIDOptional

Exclusive controller binding on this network. Update omission preserves it; upsert omission clears it.

References controller

identifierString!Required

Unique device identifier (required)

forces replacement

nameStringOptional

Display name

descriptionStringOptional

Device description

deviceTypeStringOptional

Type of device

manufacturerStringOptional

Device manufacturer

modelStringOptional

Device model

serialNumberStringOptional

Device serial number

outboundProtocols[OutboundProtocolConfig!]!Optional

Outbound protocol configurations

View OutboundProtocolConfigInput fields →

inboundProtocols[InboundProtocolConfig!]!Optional

Inbound protocol configurations

View InboundProtocolConfigInput fields →

isActiveBoolean!Optional

Whether the device is active

Input types

Fields for the structured values used in this resource’s configuration.

OutboundProtocolConfigInput

Input for outbound protocol configuration

kindOutboundProtocol!Required

Protocol type (required)

Allowed values

HTTP — HTTP REST API

SQL — SQL database connection

MQTT — MQTT publish

JMF — JMF (Job Messaging Format)

labelStringOptional

User-defined label

urlStringOptional

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

authModeAuthModeOptional

Authentication mode

Allowed values

NONE — No authentication

BASIC — HTTP Basic authentication

BEARER — HTTP Bearer token authentication

bearerPrefixStringOptional

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

bearerTokenStringOptional

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

usernameStringOptional

Username for authentication

passwordStringOptional

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

adapterDatabaseAdapterOptional

Database adapter for SQL protocol

Allowed values

MSSQL — Microsoft SQL Server

MYSQL — MySQL

POSTGRESQL — PostgreSQL

SQLITE — SQLite (file-based)

ORACLE — Oracle

hostStringOptional

Host for SQL protocol

portIntOptional

Port for SQL protocol

databaseNameStringOptional

Database name for SQL protocol

connectionStringStringOptional

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

topicStringOptional

Topic for MQTT protocol

InboundProtocolConfigInput

Input for inbound protocol configuration

kindInboundProtocol!Required

Protocol type (required)

Allowed values

MQTT — MQTT subscription

HTTP — HTTP webhook receiver

labelStringOptional

User-defined label

topicStringOptional

Topic for MQTT protocol

webhookPathStringOptional

Path for HTTP webhook

Read-only values

Show values
idDeviceID!Read only

Unique identifier

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

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.