nRF Cloud Device Job Service (0.0.1)

Retrieve a list of device jobs

Create a device job

Get information about a device job

Delete a device job

Update a job's status and target list type. Changing the status to IN_PROGRESS starts the job. Changing the status to CANCELED will cancel all currently QUEUED executions and put the job in a CANCELED state, although any IN_PROGRESS executions will continue to run. Locking a target list prevents any devices that are newly eligible for this job to be automatically added.

Cancel all executions in a FAILED or TIMED_OUT status, then create new job to retry.

Get a list of job executions for a device job

This operation only affects job executions that are in the following states: QUEUED, TIMED_OUT, FAILED. If no device IDs are specified in the request body, all job executions will be updated.

Cancel all executions in a FAILED or TIMED_OUT status, then create new job to retry.

Get list of job executions for a device in a job

By default, this operation updates the current job execution. For updating a specific job execution, specify the execution ID in the request body.

Get list of job executions for a device

Get the current device job execution for a device

Upload a bundle as a .zip file, whether binary or base64-encoded. The bundle must contain a manifest.json file that conforms to this JSON schema:

{
  name?: string,
  description?: string,
  fwversion: string,
  'format-version': 1,
  files: {
    file: string,
    size: number
  }[]
}

Notes:

• ? fields are optional
• files is an array of objects, all of which should be of the same type.
• type values application and mcuboot apply only to nRF91 FOTA. Values softdevice and init_packet apply only to Bluetooth LE FOTA.
• For Bluetooth LE devices using FOTA, the .zip file must contain both the init_packet and the firmware image (application or soft device). The type field for the manifest must be application or softdevice, not init_packet.
• 'format-version' should always be set to 1
• fwversion is validated against this regular expression: /^[a-zA-Z0-9._-]{1,30}$/
• The Zephyr build system produces dfu_application.zip in the build/zephyr folder, which contains a manifest.json plus the update binary. However, the manifest is currently generated without the required fwversion field, so you will need to add that field.
• If you use the nRFCloud.com user interface to upload your zip file, you are given options to fill in the name, description, and fwversion fields. The UI will then properly generate the manifest.json file and zip file.
• Although nRF Cloud supports modem FOTA, we do not allow uploading modem firmware. These updates are made available only by Nordic Semiconductor.

An example of a valid manifest:

{
  "name": "My application update",
  "description": "Changelog: Fixed an issue with sleep mode. Power consumption improvements.",
  "fwversion": "1.1",
  "format-version": 1,
  "files": [
    {
      "file": "my_application_v1_1.hex.bin",
      "type": "application",
      "size": 695672
    }
  ]
}

Following are examples of uploading with curl (base64 and binary):

  export FILE=$(base64 path/to/my-file.zip)
  # If you get a console error such as "Argument list too long" try using a REST client like Postman.
  curl -X POST $API_HOST/bundles -H "Authorization: Bearer $API_KEY" -H "Content-Type: text/plain" -d $FILE

  curl -X POST $API_HOST/bundles -H "Authorization: Bearer $API_KEY" -H "Content-Type: application/zip" --data-binary @/path/to/my-file.zip

For more information, see the FOTA documentation.

Get a list of device job bundles

Get information about a specific bundle

Delete a device job bundle

Get list of scheduled events for a job

Update the trigger date of a scheduled job event