API ReferenceDevice Channels

Connect a new device channel

We can connect a new channel with the following request

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-client-versionstringOptionalDefaults to 0.0.0
Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/

Request

Payload
client_idstringRequiredformat: "uuid"
device_model_idstringRequiredformat: "uuid"

Response

Example response
_typestringDefaults to project_device_channel
idstringformat: "uuid"
actor_idstringformat: "uuid"
asset_typeenum
Allowed values:
device_idstringformat: "uuid"
external_indexdouble0-100
inserted_atstringformat: "date-time"
namestring

Auto-generated name, based on the device model

project_idstring
The Project ID that this device is linked to
project_device_idstring
real_time_logging_capablebooleanDefaults to false
statusenum
Allowed values:
updated_atstringformat: "date-time"

Errors

401
Unauthorized Error
409
Conflict Error