Skip to content
OTA-Pulse Docs

Update Firmware

PATCH
/api/firmware/{firmware_id}
 
curl --request PATCH \
  --url 'https://example.com/api/firmware/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "is_mandatory": true, "name": "example", "release_notes": "example", "rollout_percentage": 1, "status": "draft" }'

Update firmware metadata

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
firmware_id
required
Firmware Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
FirmwareUpdate

Firmware update

object
description
Any of:
string
is_mandatory
Any of:
boolean
name
Any of:
string
release_notes
Any of:
string
rollout_percentage
Any of:
number
<= 100
status
Any of:
FirmwareStatus

Firmware status

string
Allowed values: draft testing released deprecated

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
FirmwareResponse

Firmware response

object
checksum
required
Any of:
string
checksum_type
required
Checksum Type
string
created_at
required
Created At
string format: date-time
description
Any of:
string
download_count
required
Download Count
integer
failure_count
required
Failure Count
integer
file_path
Any of:
string
file_size
required
Any of:
integer
hardware_versions
required
Hardware Versions
Array<string>
id
required
Id
string format: uuid
install_count
required
Install Count
integer
is_mandatory
required
Is Mandatory
boolean
is_mender_artifact
Is OTA artifact (deprecated)

Deprecated alias for is_ota_artifact. Use is_ota_artifact.

boolean
is_ota_artifact
Is Ota Artifact
boolean
min_version
required
Any of:
string
name
Any of:
string
<= 255 characters
organization_id
required
Organization Id
string format: uuid
release_notes
Any of:
string
released_at
required
Any of:
string format: date-time
rollout_percentage
required
Rollout Percentage
number
signature_status
Any of:
string
status
required
FirmwareStatus

Firmware status

string
Allowed values: draft testing released deprecated
version
required
Version
string
<= 100 characters
version_code
required
Any of:
integer
Example 
{
  "is_mender_artifact": false,
  "is_ota_artifact": false,
  "status": "draft"
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}