Skip to content

Archive a firmware release

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

Retire a deprecated version: it is hidden from lists and no longer served. Refused while fleets or devices are still assigned to it.

Required scope: firmware:write.

id
required
string format: uuid

OK

Media typeapplication/json
object
id
required
string format: uuid
componentTypeId
required
string format: uuid
version
required
string
status
required
string
name
string
artifactUrl
string
checksumSha256
string
fileSizeBytes
integer format: int64

Example generated

{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"componentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"version": "example",
"status": "example",
"name": "example",
"artifactUrl": "example",
"checksumSha256": "example",
"fileSizeBytes": 1
}

Unauthorized

Not found

The version is not deprecated, or fleets or devices are still assigned to it

Media typeapplication/json
object
error
required
string

Example generated

{
"error": "example"
}