CreateOTAJobRequest
Defined in: src/types/ota.ts:98
Request body for creating a new OTA job.
Properties
Section titled “Properties”description?
Section titled “description?”
optionaldescription?:string
Defined in: src/types/ota.ts:102
Optional human-readable description, surfaced to end users on user-approval jobs.
groups?
Section titled “groups?”
optionalgroups?:string[]
Defined in: src/types/ota.ts:110
Target group IDs.
metadata?
Section titled “metadata?”
optionalmetadata?:OtaJobMetadata
Defined in: src/types/ota.ts:122
Optional job metadata (download window, validity, target MCU, custom keys).
network_serialisation?
Section titled “network_serialisation?”
optionalnetwork_serialisation?:OtaNetworkSerialisation
Defined in: src/types/ota.ts:126
Network serialisation options.
node_fw_version?
Section titled “node_fw_version?”
optionalnode_fw_version?:string
Defined in: src/types/ota.ts:120
Node firmware version filter (Dynamic OTA jobs).
node_model?
Section titled “node_model?”
optionalnode_model?:string
Defined in: src/types/ota.ts:118
Node model filter (Dynamic OTA jobs).
node_type?
Section titled “node_type?”
optionalnode_type?:string
Defined in: src/types/ota.ts:116
Node type filter (Dynamic OTA jobs).
nodes?
Section titled “nodes?”
optionalnodes?:string[]
Defined in: src/types/ota.ts:108
Target node IDs.
ota_image_id?
Section titled “ota_image_id?”
optionalota_image_id?:string
Defined in: src/types/ota.ts:104
ID of the OTA image to deploy (mutually exclusive with ota_image_url).
ota_image_url?
Section titled “ota_image_url?”
optionalota_image_url?:string
Defined in: src/types/ota.ts:106
Image URL to deploy (mutually exclusive with ota_image_id).
ota_job_name
Section titled “ota_job_name”ota_job_name:
string
Defined in: src/types/ota.ts:100
Name of the OTA job (required).
priority?
Section titled “priority?”
optionalpriority?:number
Defined in: src/types/ota.ts:112
Job priority, 1 (highest) to 10 (lowest).
secure_boot?
Section titled “secure_boot?”
optionalsecure_boot?:OtaSecureBoot
Defined in: src/types/ota.ts:124
Secure boot signing options.
timeout?
Section titled “timeout?”
optionaltimeout?:number
Defined in: src/types/ota.ts:114
Timeout in seconds after which the job expires.
user_ota_image_acccess?
Section titled “user_ota_image_acccess?”
optionaluser_ota_image_acccess?:boolean
Defined in: src/types/ota.ts:131
Grant end users access to the firmware binary URL on user-approval OTA jobs. Note: the property name is intentionally misspelt to match the backend contract.