Glossary of important terms about the Notecard and Notehub

Glossary

System Notefiles are created on Notehub in response to system events and can be routed.

System Notefiles

This API reference contains an alphabetical overview of all API requests relevant to the Notecard and Notehub. The sections below detail the options available for each request, what each request returns, and example requests.

Notecard API Introduction

Introduction

The Notecard provides a number of requests that can be used to configure the behavior of the Notecard, its pins, its use of GPS and accelerometer data, and to query the state of the Device, its network connection and peripherals.

card Requests - API Reference

card.attn

card.aux

card.aux.serial

card.binary

card.binary.get

card.binary.put

card.carrier

card.contact

card.dfu

card.io

card.location

card.location.mode

card.location.track

card.monitor

card.motion

card.motion.mode

card.motion.sync

card.motion.track

card.random

card.restart

card.restore

card.sleep

card.status

card.temp

card.time

card.transport

card.triangulate

card.usage.get

card.usage.test

card.version

card.voltage

card.wifi

card.wireless

card.wireless.penalty

card Requests

the Notecard offers a set of host firmware update APIs that can be utilized by developers, in concert with Notehub, to update the firmware of a [Host MCU]

dfu Requests - API Reference

dfu.get

dfu.status

dfu Requests

Environment variables are key-value pairs that can be set on the Notecard, or on a device, project and fleet in Notehub.

env Requests - API Reference

env.default

env.get

env.modified

env.set

env Requests

The file set of requests enable developers to work with all types of Notefiles.

file Requests - API Reference

file.changes

file.changes.pending

file.delete

file.stats

file Requests

The hub set of requests provide a variety of ways for a developer to configure and monitor the connection between the Notecard and Notehub.

hub Requests - API Reference

hub.device.signal

hub.get

hub.log

hub.set

hub.signal

hub.status

hub.sync

hub.sync.status

hub Requests

The note requests enable the quick creation and management of Notes in Notefiles.

note Requests - API Reference

note.add

note.changes

note.delete

note.get

note.update

note.template

note Requests

The Notecard can perform requests and obtain responses from 3rd Party APIs and services with the web API requests.

web Requests - API Reference

web.get

web.post

web.put

web.delete

web Requests

Notecard API

This API reference contains an overview of all requests relevant to interacting with Notehub.io. Each section details request and response parameters, along with example curl requests and JSON responses.

Notehub API Introduction

Authentication with OAuth Bearer Tokens

Authentication with Session Tokens (Deprecated)

API Calls and Consumption Credits

Postman Collection for Notehub API

API Introduction

The Notehub device API provides RESTful methods that can be used to GET data related to Notehub billing accounts.

Billing Account API - Notehub API Reference

Get Billing Accounts

Billing Account API

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

Device API - Notehub API Reference

Get Devices

Get Device by UID

Delete Device by UID

Enable Device by UID

Disable Device by UID

Provision Device

Send Device Signal

Enable Connectivity Assurance

Disable Connectivity Assurance

Device API

The Notehub environment variable API provides RESTful methods that can be used to GET, PUT, and DELETE data related to environment variables.

Environment Variable API - Notehub API Reference

Get Environment Variables

Set Environment Variables

Delete Environment Variable

Get Environment Variables by Fleet

Set Environment Variables by Fleet

Delete Environment Variable by Fleet

Get Environment Variables by Device

Set Environment Variables by Device

Delete Environment Variable by Device

Environment Variable API

The Notehub event API provides RESTful methods that can be used to GET event data.

Event API - Notehub API Reference

Get Events by Project

Get Events by Cursor

Get Latest Events

Get Health Log

Get Sessions

Get Events by Fleet

Get Fleet Events by Cursor

Event API

The Notehub file API provides RESTful methods that can be used to manage Notefiles.

File API - Notehub API Reference

File API

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

Fleet API - Notehub API Reference

Get Fleets

Create Fleet

Update Fleet

Delete Fleet

Get Fleets by Device

Get Devices by Fleet

Add Device to Fleets

Remove Device from Fleets

Fleet API

The Notehub note API provides RESTful methods that can be used to manage notes.

Note API - Notehub API Reference

Note API

The Notehub product API provides RESTful methods that can be used to GET product data.

Product API - Notehub API Reference

Get Products

Create Product

Product API

The Notehub project API provides RESTful methods that can be used to GET project data.

Project API - Notehub API Reference

Get Project

Get Projects

Get Project by Product

Get Project Members

Create Project

Set Global JSONata Transform

Enable Global JSONata Transform

Disable Global JSONata Transform

Clone Project

Project API

The Notehub route API provides RESTful methods that can be used to GET, POST, PUT, and DELETE Notehub routes.

Route API - Notehub API Reference

Get Routes

Get Route by UID

Create Route

Update Route by UID

Delete Route by UID

Route API

The Notehub route logs API provides RESTful methods that can be used to GET Notehub route logs by event or by route.