Connect a new device channel

We can connect a new channel with the following request

SecurityC2COAuth2
Request
header Parameters
x-client-version
string
Default: 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/

Example: 2.16.4
Request Body schema: application/json

Payload

client_id
string <uuid>
device_model_id
string <uuid>
Responses
200

Example response

Response Schema: application/json
_type
string
Default: "project_device_channel"
id
string <uuid>
actor_id
string <uuid>
asset_type
string
Enum: "audio" "video" "data"
device_id
string <uuid>
external_index
number [ 0 .. 100 ]
inserted_at
string <date-time>
name
string

Auto-generated name, based on the device model

project_id
string

The Project ID that this device is linked to

project_device_id
string
real_time_logging_capable
boolean
Default: false
status
string
Enum: "offline" "online"
updated_at
string <date-time>
401

Unauthorized response

409

Device channel already exists

post/v2/devices/channels
Request samples
application/json
{ }
Response samples
application/json
{
  • "_type": "project_device_channel",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
  • "asset_type": "audio",
  • "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  • "external_index": 100,
  • "inserted_at": "2021-08-03T00:00:00Z",
  • "name": "string",
  • "project_id": "string",
  • "project_device_id": "string",
  • "real_time_logging_capable": false,
  • "status": "offline",
  • "updated_at": "2021-08-03T00:00:00Z"
}