Skip to content

Add encoder

PUT
/encoder/{encoderId}

Registers an encoder with the authenticated user’s system.

If the encoder already exists any editable information will be
updated, and new credentials will be generated and returned.

**Important: The encoderId must match the common name of the certificate.**

AllowedRoles: [service-tool]

encoderId
required
string
object
deviceCert
string
metadata
object
key
additional properties
string
name
string
nullable
publicKey
string
nullable
signature
string format: base64

OK

object
alarmState
object
changedOn
string format: date-time
raised
boolean
apps
Array<object>
nullable
object
name
string
version
string
cert
string
configurations
object
vostio
string format: base64
connectionState
object
changedOn
string format: date-time
connected
boolean
credentials
string format: base64
endpoint
string
id
string
ipAddress
string
metadata
object
key
additional properties
string
name
string
platform
object
name
string
version
string
secrets
object
iot-credentials
string format: base64
systemId
Array<integer>
nullable
upgradeJobInfo
object
apps
Array<object>
nullable
object
name
string
version
string
id
string
platform
object
name
string
version
string
version
integer
versions
Array<object>
nullable
object
name
string
version
string