Skip to content

Per-component current vs desired firmware for a device

GET
/devices/{id}/firmware
curl --request GET \
--url https://app.dev.buildtrace.eu/api/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/firmware \
--header 'Authorization: Bearer <token>'

Required scope: field:read.

id
required
string format: uuid

OK

Media typeapplication/json
object
components
required
Array<object>
object
componentTypeId
required
string format: uuid
componentTypeCode
required
string
current

Version string of the most-recently-flashed firmware for this component (absent if never flashed).

string
desired

Desired version string from the effective manifest (absent if no assignment).

string
compliant
required

True when current == desired, or when desired is absent (no assignment means no requirement). false when desired is present and current differs from desired (including never-flashed).

boolean

Example generated

{
"components": [
{
"componentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"componentTypeCode": "example",
"current": "example",
"desired": "example",
"compliant": true
}
]
}

Unauthorized

Not found