Skip to content
OTA-Pulse Docs

Create Ota Artifact

POST
/api/firmware/{firmware_id}/create-artifact

Create an OTA-Pulse artifact from an uploaded firmware binary.

This converts a raw firmware image into a proper OTA-Pulse artifact that can be installed by the soc-ota-agent.

The artifact will include:

  • Proper OTA-Pulse artifact headers
  • Device type compatibility information
  • Compression (default: gzip)

Authorizations

Parameters

Path Parameters

firmware_id
required
string format: uuid

Query Parameters

organization_id
required
string format: uuid

Request Body required

Request body for artifact creation

object
artifact_name
Any of:
string
compression
string
default: gzip
device_types
required
Array<string>

Responses

200

Successful Response

Response for artifact creation status

object
artifact_path
Any of:
string
artifact_size
Any of:
integer
checksum
Any of:
string
error
Any of:
string
status
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string