Rate this page

★
★
★
★
★
★
★
★
★
★

Device API

The Notehub device API provides RESTful methods that can be used to GET, POST, and DELETE data related to devices and fleets.

note

All device APIs are available in the context of both Notehub projects and ProductUIDs. While this document shows the ProductUID context only, you can substitute in projects for products and projectUID for productUID for each API listed.

Get Fleets

Get an array of fleets associated with a ProductUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/[productUID]/fleets'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`uid`

string

The globally-unique identifier of the fleet.

`label`

string

The user-defined label of the fleet.

`created`

string

The date and time the fleet was created.

Example Response


{
  "fleets": [
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Production",
      "created": "2021-04-10T21:18:38Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Staging",
      "created": "2021-02-11T01:03:46Z"
    },
    {
      "uid": "fleet:00000000-0000-0000-0000-000000000000",
      "label": "Testing",
      "created": "2021-02-11T01:03:32Z"
    }
  ]
}

Get Devices

Get an array of devices associated with a ProductUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/[productUID]/devices'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`uid`

string

The globally-unique identifier of the device.

`serial_number`

string

The user-defined serial number of the device.

`provisioned`

string

The date and time this device was first provisioned, or put into use.

`last_activity`

string

The date and time this device was last seen by Notehub.

`contact`

object

Contact information for this device, specified via environment variables.

`product_uid`

string

The ProductUID this device is associated with.

`fleet_uid`

string

The globally-unique identifier for the fleet this device is associated with.

`tower_info`

object

An object containing data about the cellular tower last accessed by this device.

`tower_info.mcc`

int

The mobile country code of the cell tower.

`tower_info.mnc`

int

The mobile network code of the cell tower, which identifies the mobile operator.

`tower_info.lac`

int

The location area code of the cell tower, which is a unique identifer of the current location area.

`tower_info.cell_id`

int

The Cell ID or CID of the cell tower. This is a unique number used to identify each Base Transceiver Station (BTS) or sector of a BTS within a location area code.

`tower_location`

object

An object containing information about the physical location of the cell tower.

`gps_location`

object

An object containing information about the physical location of the device, based on GPS coordinates.

`triangulated_location`

object

An object containing information about the physical location of the device based on triangulated data calculated by multiple cell towers.

`voltage`

decimal

The most recent measure of the voltage from the onboard voltage monitor.

`temperature`

decimal

The most recent temperature measure in celsius from the onboard temperature sensor.

Example Response


{
   "devices":[
      {
         "uid":"dev:000000000000000",
         "serial_number":"",
         "provisioned":"2021-02-11T02:37:16Z",
         "last_activity":"2021-05-11T19:37:08Z",
         "contact":null,
         "product_uid":"product:com.your-company.your-name:project",
         "fleet_uid":"fleet:00000000-0000-0000-0000-000000000000",
         "tower_info":{
            "mcc":310,
            "mnc":410,
            "lac":12345,
            "cell_id":12345678
         },
         "tower_location":{
            "when":"2021-05-11T19:34:23Z",
            "name":"Cassville MO",
            "country":"US",
            "timezone":"America/Chicago",
            "latitude":36.665537500000006,
            "longitude":-93.850109375
         },
         "gps_location":{
            "same properties as tower_location"
         },
         "triangulated_location":{
            "same properties as tower_location"
         },
         "voltage":5.15,
         "temperature":23.75
      }
   ]
}

Get Device by UID

Get information about a single device by its DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The globally-unique identifier of a device.

`authToken`

string

A Notehub API authentication token.


curl -X GET
     -L '[baseURL]/products/[productUID]/devices/[deviceUID]'
     -H 'X-SESSION-TOKEN: [authToken]'

Response Members

`uid`

string

The globally-unique identifier of the device.

`serial_number`

string

The user-defined serial number of the device.

`provisioned`

string

The date and time this device was first provisioned, or put into use.

`last_activity`

string

The date and time this device was last seen by Notehub.

`contact`

object

Contact information for this device, specified via environment variables.

`product_uid`

string

The ProductUID this device is associated with.

`fleet_uid`

string

The globally-unique identifier for the fleet this device is associated with.

`tower_info`

object

An object containing data about the cellular tower last accessed by this device.

`tower_info.mcc`

int

The mobile country code of the cell tower.

`tower_info.mnc`

int

The mobile network code of the cell tower, which identifies the mobile operator.

`tower_info.lac`

int

The location area code of the cell tower, which is a unique identifer of the current location area.

`tower_info.cell_id`

int

The Cell ID or CID of the cell tower. This is a unique number used to identify each Base Transceiver Station (BTS) or sector of a BTS within a location area code.

`tower_location`

object

An object containing information about the physical location of the cell tower.

`gps_location`

object

An object containing information about the physical location of the device, based on GPS coordinates.

`triangulated_location`

object

An object containing information about the physical location of the device, based on triangulated data calculated by multiple cell towers.

`voltage`

decimal

The most recent measure of the voltage from the onboard voltage monitor.

`temperature`

decimal

The most recent temperature measure in celsius from the onboard temperature sensor.

Example Response


{
    "uid":"dev:000000000000000",
    "serial_number":"",
    "provisioned":"2021-02-11T02:37:16Z",
    "last_activity":"2021-05-11T19:37:08Z",
    "contact":null,
    "product_uid":"product:com.your-company.your-name:project",
    "fleet_uid":"fleet:00000000-0000-0000-0000-000000000000",
    "tower_info":{
      "mcc":310,
      "mnc":410,
      "lac":12345,
      "cell_id":12345678
    },
    "tower_location":{
      "when":"2021-05-11T19:34:23Z",
      "name":"Cassville MO",
      "country":"US",
      "timezone":"America/Chicago",
      "latitude":36.665537500000006,
      "longitude":-93.850109375
    },
    "gps_location":{
      "same properties as tower_location"
    },
    "triangulated_location":{
      "same properties as tower_location"
    },
    "voltage":5.15,
    "temperature":23.75
}

Delete Device by UID

Delete a single device by its DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The globally-unique identifier of a device.

`purge`

boolean

true performs a deep delete that removes the device and all associated data (e.g. events, settings, files, and sessions) from Notehub. false will perform a shallow delete that only removes the device, but other data will persist.

`authToken`

string

A Notehub API authentication token.


curl -X DELETE
     -L '[baseURL]/products/[productUID]/devices/[deviceUID]?purge=[purge]'
     -H 'X-SESSION-TOKEN: [authToken]'

Enable Device by UID

Enable a disabled device by its DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The globally-unique identifier of a device.

`authToken`

string

A Notehub API authentication token.


curl -X POST
     -L '[baseURL]/products/[productUID]/devices/[deviceUID]/enable'
     -H 'X-SESSION-TOKEN: [authToken]'

Disable Device by UID

Disable a device by its DeviceUID.

Minimum Notehub project-level role required:

Arguments

`baseURL`

string

The Notehub API endpoint URL. For example: https://api.notefile.net/v1.

`productUID`

string

The ProductUID from a Notehub project.

`deviceUID`

string

The globally-unique identifier of a device.

`authToken`

string

A Notehub API authentication token.


curl -X POST
     -L '[baseURL]/products/[productUID]/devices/[deviceUID]/disable'
     -H 'X-SESSION-TOKEN: [authToken]'

API Introduction Environment Variable API