HTTP Endpoint

Update

GET https://device.nerves-hub.org/device/update

This endpoint allows you to poll for firmware updates.

Headers

NameTypeDescription

X-NervesHub-uuid*

string

The running firmware's UUID

X-NervesHub-vcs:identifier

string

A version control system tag or identifier on the running firmware if any

X-NervesHub-version*

string

The running firmware's version number

X-NervesHub-product

string

The product name that's encoded into the running firmware

X-NervesHub-platform

string

The running firmware's platform field

X-NervesHub-description

string

The running firmware's description field

X-NervesHub-author

string

The author metadata in the running firmware

X-NervesHub-architecture*

string

The device's architecture.

{
    "update_available": true,
    "deployment_id": 12,
    "firmware_url": "Some URL",
    "firmware_meta": {
      "uuid": "12345-6789-0129435",
      "architecture": "arm",
      "platform": "rpi0",
      "product": "MyProduct",
      "version": "1.1.10",
      "author": "Ron Swanson",
      "description": "baconator 3000",
      "vcs_identifier": "some_version_control_sha",
      "misc": "random data"
    }
}

Last updated