Apply a Firmware Update to Phones

Applies a firmware update to the phones that use the firmware, and triggers the phones to fetch the new configuration.

Request URL

POST {base_url}/uc-cautop/api/v1/firmwares/{firmwareId}/update-to-device

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
firmwareId Yes String The firmware ID. You can obtain the ID using the Search Firmwares interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<Apply_Result> The result of the update.
Apply_Result
Parameter Type Description
triggeredCount Integer The number of phones triggered to update.