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

_geolocate.qo

_health.qo

_motion.qo

_session.qo

_track.qo

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.led

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 a device, project, or fleet.

env Requests - API Reference

env.default

env.get

env.modified

env.set

env.template

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.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

Use a compatible Notecard to interface with a paired Starnote device for NTN (satellite) communications.

ntn Requests - API Reference

ntn.reset

ntn Requests

Provides a simple interface for managing data stored in DB Notefiles.

var Requests - API Reference

var.delete

var.get

var.set

var 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 authorization API contains an endpoint to generate an OAuth bearer token.

Authorization API - Notehub API Reference

Generate OAuth Token

Generate Session Token

Authorization API

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 Project Devices

Get Device

Delete Device

Disable Device

Enable Device

Disable Connectivity Assurance

Enable Connectivity Assurance

Delete Device Environment Variable

Get Device Environment Variables

Set Device Environment Variables

Get Device Health Log

Get Device Latest Events

Get Device Sessions

Get Fleet Devices

Get Note

Get Note Changes

Add Note

Update Note

Delete Note

Send Signal

Get Notefile Changes

Get Pending Notefile Changes

Delete Notefile

Provision Device

Device API

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

Event API - Notehub API Reference

Get Project Events

Get Project Events by Cursor

Get Fleet Events

Get Fleet Events by Cursor

Get Route Logs by Event

Event API

The Notehub monitor API provides RESTful methods that can be used to manage project alerts.

Monitor API - Notehub API Reference

Get Monitors

Get Monitor

Create Monitor

Delete Monitor

Update Monitor

Monitor API

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

Project API - Notehub API Reference

Get Projects

Get Project

Get Project by Product

Create Project

Delete Project

Clone Project

Get Project Members

Create Product

Get Products

Get Project Environment Variables

Delete Project Environment Variable

Set Project Environment Variables

Get Fleet Environment Variables

Delete Fleet Environment Variable

Set Fleet Environment Variables

Get Fleets

Create Fleet

Update Fleet

Delete Fleet

Get Device Fleets

Add Device to Fleets

Remove Device from Fleets

Set Global JSONata Transform

Enable Global JSONata Transform

Disable Global JSONata Transform

Get Available Firmware

Update Firmware

Get Firmware Update Status

Project API

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

API Reference

Notecard API

In this section

Notehub API

In this section

Other Resources

Glossary

System Notefiles