Menu

Knox E-FOTA REST API Reference

Overview

Knox E-FOTA enables enterprises to control which versions of firmware updates are installed on their employees' devices. This control is a benefit to an enterprise since it allows IT admins to:

  • Verify that business-critical software is compatible with a specific firmware version before rolling out the firmware to employees. Specifying firmware can prevent conflicts between corporate software and firmware that can break business processes and reduce productivity.
  • Quickly roll out to all enterprise devices a firmware version to all enterprise devices that fixes a critical security issue or bug. This deployment speed can prevent the propagation of known security exploits.

For step-by-step details on how to set up Knox E-FOTA, see the Knox E-FOTA Developer Guide.

Quick reference

This REST API reference provides details about the syntax of the Knox E-FOTA REST API calls:

Knox E-FOTA V2

Introducing Knox E-FOTA version 2, with a set of new features and capabilities to help you manage your enterprise devices.

The following table highlights what's new for Knox E-FOTA:

New API overview

API Description
groupLicenseChange API to change the Knox E-FOTA license associated to a group ID.
forceUpdateDetail

API to return a list of devices that is processing the push update or has failed to download the push update associated with a specified force update ID.

NOTE — The API call is only available for 3 months after the force update ID is generated.
forceUpdateSummary

API to return a force update summary that includes a count of the devices that has currently downloaded, failed to download or is currently processing a target firmware update.

NOTE — The API call is only available for 3 months after the force update ID is generated.
abnormalDeviceList

API to return the fail status of a list of devices that was unable to enrol into the Knox E-FOTA service.

Change group licenses

With Knox E-FOTA version 2, IT admins can easily change group licenses through the introduction of a new API: groupLicenseChange from the class/method MDMDeviceServiceResource.setB2bGroupLicenseChange, which changes Knox E-FOTA licenses associated with a group ID.

For more details, see the groupLicenseChange API for Knox E-FOTA version 2.

Force update details

With Knox E-FOTA version 2, after IT admin pushes a firmware update request, they can now get the details associated with a specific force update ID with the introduction of a new API forceUpdateDetail API from the class/method MDMDeviceServiceResource.getB2bForceUpdateDetail. This API provides the following details:

  • A list of devices currently processing the firmware over-the-air (FOTA) forced push update.
  • A list of devices that has failed to download the FOTA force push update.
  • Details regarding why a device has failed to download the FOTA force push update.

Note that this API call is available for 3 months after the force update request. For more details, see the forceUpdateDetail API for Knox E-FOTA version 2.

Force update summary

With Knox E-FOTA version 2, after IT admins pushes a firmware update request, they can now get the summary associated with a specific force update ID with the introduction of a new API forceUpdateSummary API from the class/method MDMDeviceServiceResource.getB2bForceUpdateSummary. This API provides a summary containing the following:

  • The target firmware version pushed to the device during the force push update.
  • The number of devices that's currently processing the FOTA push update.
  • The number of devices that's successfully downloaded the FOTA push update.
  • The number of devices that's failed to download the FOTA push update.

Note that this API call is available for 3 months after the force update request. For more details, see the forceUpdateSummary API for Knox E-FOTA version 2.

Get failed enrolment status

With the release of Knox E-FOTA version 2, IT admins can get the fail status for up to 100 devices per API call with the new API abnormalDeviceList from the class/method MDMDeviceServiceResource.getB2bAbnormalDeviceList.

For more details, see the abnormalDeviceList API for Knox E-FOTA version 2.

Updated APIs

Knox E-FOTA v1 API Knox E-FOTA v2 API revision Description
firmware firmwareList

API to return the list of firmware versions available.

licenseInfo licenseInfo

API to return information about Knox E-FOTA license.

serverInit forceUpdate

API to push a force update to a list of Knox E-FOTA devices.

serviceRegister groupRegister

API to register a group of IDs and licenses to Knox E-FOTA.

Firmware List

URL change:https://eu-api.samsungknox.com/b2bfota/v2/firmwareList

The Knox E-FOTA v2 API, firmwareList, from the class/method MDMDeviceServiceResource.getB2bFirmwareList is a revision of the Knox E-FOTA v1 API firmware. The revision includes the following changes:

  • Request parameter:
    • groupID was removed.
    • carrierCode was renamed to salesCode
  • Response parameter:
    • New parameters added: samsungSecurityPatchDate

For more details, see the firmwareList API for Knox E-FOTA version 2.

License info

URL change:https://eu-api.samsungknox.com/b2bfota/v2/licenseInfo

The Knox E-FOTA v1 API, licenseInfo, from the class/method MDMDeviceServiceResource.getB2bLicenseInfo comes with the following revisions with the release of Knox E-FOTA v2:

  • Request parameter:
    • groupID was removed.
  • Response parameter:
    • New parameter added: samsungSecurityPatchDate, licenseStatus, licenseType, remainingQuantity, blockedDeviceCount
    • expirationDate has changed to activePeriod.
    • maxDeviceCount has changed to purchasedQuantity.

For more details, see the licenseInfo API for Knox E-FOTA version 2.

Force Update

URL change:https://eu-api.samsungknox.com/b2bfota/v2/forceUpdate

IT admins can now easily execute force updates of up to 100 Knox E-FOTA devices per API call with the introduction of Knox E-FOTA's v2 API forceUpdate from the class/method MDMDeviceServiceResource.setB2bForceUpdate.

This API is a revision of the Knox E-FOTA v1 api serverInit, and includes the following revisions:

  • Request parameter:
    • groupID was removed.
    • Schedule function was removed. The following parameters was removed: deliveryStatDate, deliveryEndDate, dailyStartHour, and dailyEndHour.
    • carrierCode was renamed to salesCode.
    • targetFirmwareVersion can be set to Latest to update the device to the latest firmware version available.
    • New parameters added: networkType.
    • The ability to force update up to 100 devices registered to a license is now supported.
  • Response parameter:
    • New parameter added: forceUpdateID.

For more details, see the forceUpdate API for Knox E-FOTA version 2.

Group register

URL change:https://eu-api.samsungknox.com/b2bfota/v2/groupRegister

The Knox E-FOTA v2 API groupRegister from the class/method MDMDeviceServiceResource.setB2bGroupRegister is a revision of the Knox E-FOTA v1 API , serviceRegister which registers a group of devices associated to a group ID to a Knox E-FOTA license. The revision includes an API VO name change and a URL change.

For more details, see the groupRegister API for Knox E-FOTA version 2.

Knox E-FOTA V1

Samsung releases new versions of Android firmware to provide new features, improve performance and resolve known bugs. While each firmware undergoes comprehensive testing and certification on our extensive range of mobile devices, you may want to wait before deploying new firmware updates to your organization's devices.

With Knox E-FOTA, you can control the deployment of new firmware with the following features:

  • Select the highest firmware version allowed on devices.
  • Force the download of a specific firmware version onto a fleet of devices without requiring user actions.
  • Schedule downloads during non-business hours when mobile workers aren't using their devices.

The following table highlights APIs for Knox E-FOTA:

Knox E-FOTA V1 API overview

API call Description
firmware

API returns a list of firmware versions available for update.

licenseInfo

API returns the maximum number of devices and expiration date for an Knox E-FOTA license.

serverInit API pushes a force firmware update for Knox E-FOTA devices in a specified time period.
serviceRegister API registers a group of devices associated with a group ID to use the Knox E-FOTA service.