Skip to content

Read encoder by id

GET
/encoder/{encoderId}

Returns information about the specified encoder.

AllowedRoles: [service-tool pms front-desk front-desk-admin]

encoderId
required
string

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