Notehub API
The OpenAPI definition for the Notehub.io API.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The OpenAPI definition for the Notehub.io API.
Endpoints 137
authorization
- POSTLogin
/auth/loginGets an API key from username and password - POSTIssue an OAuth 2.0 access token (Client Credentials)
/oauth2/tokenExchanges client credentials for an access token. Parameters must be sent as application/x-www-form-urlencoded.
organization
- GETGetOrganizations
/v1/organizationsGet Organizations accessible by the api_key - GETGetOrganization
/v1/organizations/:organizationUIDGet Organization Information - GETGetOrganizationBalanceHistory
/v1/organizations/:organizationUID/balance-historyGet Organization Balance history
project
- GETGetProjectByProduct
/v1/products/:productUID/projectGet a Project by ProductUID - GETGetProjects
/v1/projectsGet Projects accessible by the api_key - POSTCreateProject
/v1/projectsCreate a Project - GETGetProject
/v1/projects/:projectOrProductUIDGet a Project by ProjectUID - DELETEDeleteProject
/v1/projects/:projectOrProductUIDDelete a Project by ProjectUID - GETGet AWS role configuration for role-based authentication
/v1/projects/:projectOrProductUID/aws-role-configReturns the AWS Account ID and External ID needed to configure an IAM role trust policy for role-based authentication on AWS routes. - POSTCloneProject
/v1/projects/:projectOrProductUID/cloneClone a Project - GETGetDeviceDfuHistory
/v1/projects/:projectOrProductUID/devices/:deviceUID/dfu/:firmwareType/historyGet device DFU history for host or Notecard firmware - GETGetDeviceDfuStatus
/v1/projects/:projectOrProductUID/devices/:deviceUID/dfu/:firmwareType/statusGet device DFU history for host or Notecard firmware - GETGetDeviceFleets
/v1/projects/:projectOrProductUID/devices/:deviceUID/fleetsGet Device Fleets - PUTAddDeviceToFleets
/v1/projects/:projectOrProductUID/devices/:deviceUID/fleetsAdd Device to Fleets - DELETEDeleteDeviceFromFleets
/v1/projects/:projectOrProductUID/devices/:deviceUID/fleetsRemove Device from Fleets - POSTPerformDfuAction
/v1/projects/:projectOrProductUID/dfu/:firmwareType/:actionUpdate/cancel host or notecard firmware updates - GETGetDevicesDfuHistory
/v1/projects/:projectOrProductUID/dfu/:firmwareType/historyGet host or Notecard DFU history for all devices that match the filter criteria - GETGetDevicesDfuStatus
/v1/projects/:projectOrProductUID/dfu/:firmwareType/statusGet host or Notecard DFU history for all devices that match the filter criteria - GETGet environment variable hierarchy for a device
/v1/projects/:projectOrProductUID/environment_hierarchy - GETGetProjectEnvironmentVariables
/v1/projects/:projectOrProductUID/environment_variablesGet environment variables of a project - PUTSetProjectEnvironmentVariables
/v1/projects/:projectOrProductUID/environment_variablesSet environment variables of a project - DELETEDeleteProjectEnvironmentVariable
/v1/projects/:projectOrProductUID/environment_variables/:keyDelete an environment variable of a project by key - GETGetFirmwareInfo
/v1/projects/:projectOrProductUID/firmwareGet Available Firmware Information - GETDownloadFirmware
/v1/projects/:projectOrProductUID/firmware/:firmwareType/:filenameDownload firmware binary - PUTUploadFirmware
/v1/projects/:projectOrProductUID/firmware/:firmwareType/:filenameUpload firmware binary - POSTUpdateFirmware
/v1/projects/:projectOrProductUID/firmware/:firmwareType/:filenameUpdate the metadata of an existing host firmware entry. The filename must be the full stored filename including the timestamp suffix (e.g.… - DELETEDeleteFirmware
/v1/projects/:projectOrProductUID/firmware/:firmwareType/:filenameDelete a host firmware binary. The filename must be the full stored filename including the timestamp suffix (e.g. test$20260324190911.bin) as returned by the… - GETGetFleets
/v1/projects/:projectOrProductUID/fleetsGet Project Fleets - POSTCreateFleet
/v1/projects/:projectOrProductUID/fleetsCreate Fleet - GETGetFleet
/v1/projects/:projectOrProductUID/fleets/:fleetUIDGet Fleet - PUTUpdateFleet
/v1/projects/:projectOrProductUID/fleets/:fleetUIDUpdate Fleet - DELETEDeleteFleet
/v1/projects/:projectOrProductUID/fleets/:fleetUIDDelete Fleet - GETGet environment variable hierarchy for a device
/v1/projects/:projectOrProductUID/fleets/:fleetUID/environment_hierarchy - GETGetFleetEnvironmentVariables
/v1/projects/:projectOrProductUID/fleets/:fleetUID/environment_variablesGet environment variables of a fleet - PUTSetFleetEnvironmentVariables
/v1/projects/:projectOrProductUID/fleets/:fleetUID/environment_variablesSet environment variables of a fleet - DELETEDeleteFleetEnvironmentVariable
/v1/projects/:projectOrProductUID/fleets/:fleetUID/environment_variables/:keyDelete environment variables of a fleet - POSTSetGlobalEventTransformation
/v1/projects/:projectOrProductUID/global-transformationSet the project-level event JSONata transformation - POSTDisableGlobalEventTransformation
/v1/projects/:projectOrProductUID/global-transformation/disableDisable the project-level event JSONata transformation - POSTEnableGlobalEventTransformation
/v1/projects/:projectOrProductUID/global-transformation/enableEnable the project-level event JSONata transformation - GETGetProjectMembers
/v1/projects/:projectOrProductUID/membersGet Project Members - GETGetProducts
/v1/projects/:projectOrProductUID/productsGet Products within a Project - POSTCreateProduct
/v1/projects/:projectOrProductUID/productsCreate Product within a Project - DELETEDeleteProduct
/v1/projects/:projectOrProductUID/products/:productUIDDelete a product - GETGet variable format for a notefile
/v1/projects/:projectOrProductUID/schemas - GETGetProjectSecrets
/v1/projects/:projectOrProductUID/secretsGet all secrets for a project (metadata only, values are never returned) - POSTCreateProjectSecret
/v1/projects/:projectOrProductUID/secretsCreate a new project secret - PUTUpdateProjectSecret
/v1/projects/:projectOrProductUID/secrets/:secretNameUpdate the value of an existing project secret - DELETEDeleteProjectSecret
/v1/projects/:projectOrProductUID/secrets/:secretNameDelete a project secret by name
event
- GETGetEvents
/v1/projects/:projectOrProductUID/eventsGet Events of a Project - GETGetEventsByCursor
/v1/projects/:projectOrProductUID/events-cursorGet Events of a Project by cursor - GETGetRouteLogsByEvent
/v1/projects/:projectOrProductUID/events/:eventUID/route-logsGet Route Logs by Event UID - GETGetFleetEvents
/v1/projects/:projectOrProductUID/fleets/:fleetUID/eventsGet Events of a Fleet - GETGetFleetEventsByCursor
/v1/projects/:projectOrProductUID/fleets/:fleetUID/events-cursorGet Events of a Fleet by cursor
device
- GETGetDeviceEnvironmentVariablesByPin
/v1/products/:productUID/devices/:deviceUID/environment_variables_with_pinGet environment variables of a device with device pin authorization - PUTSetDeviceEnvironmentVariablesByPin
/v1/products/:productUID/devices/:deviceUID/environment_variables_with_pinSet environment variables of a device with device pin authorization - GETGetDevices
/v1/projects/:projectOrProductUID/devicesGet Devices of a Project - GETGetDevice
/v1/projects/:projectOrProductUID/devices/:deviceUIDGet Device - DELETEDeleteDevice
/v1/projects/:projectOrProductUID/devices/:deviceUIDDelete Device - POSTDisableDevice
/v1/projects/:projectOrProductUID/devices/:deviceUID/disableDisable Device - POSTEnableDevice
/v1/projects/:projectOrProductUID/devices/:deviceUID/enableEnable Device - GETGet environment variable hierarchy for a device
/v1/projects/:projectOrProductUID/devices/:deviceUID/environment_hierarchy - GETGetDeviceEnvironmentVariables
/v1/projects/:projectOrProductUID/devices/:deviceUID/environment_variablesGet environment variables of a device - PUTSetDeviceEnvironmentVariables
/v1/projects/:projectOrProductUID/devices/:deviceUID/environment_variablesSet environment variables of a device - DELETEDeleteDeviceEnvironmentVariable
/v1/projects/:projectOrProductUID/devices/:deviceUID/environment_variables/:keyDelete environment variable of a device - GETListNotefiles
/v1/projects/:projectOrProductUID/devices/:deviceUID/filesLists .qi and .db files for the device - DELETEDeleteNotefiles
/v1/projects/:projectOrProductUID/devices/:deviceUID/filesDeletes Notefiles and the Notes they contain. - GETGetDeviceHealthLog
/v1/projects/:projectOrProductUID/devices/:deviceUID/health-logGet Device Health Log - GETGetDeviceJourneys
/v1/projects/:projectOrProductUID/devices/:deviceUID/journeysGet the list of journeys for a device, derived from events whose body contains journey and jcount fields. Returns journey metadata only (no event payloads).… - GETGetDeviceJourney
/v1/projects/:projectOrProductUID/devices/:deviceUID/journeys/:journeyIDGet a single journey for a device along with its events. The events array is paginated via pageSize / pageNum; use journey.has_more to detect additional pages. - GETGetDeviceLatestEvents
/v1/projects/:projectOrProductUID/devices/:deviceUID/latestGet Device Latest Events - POSTCreateNotefile
/v1/projects/:projectOrProductUID/devices/:deviceUID/notefiles/:notefileIDCreates an empty Notefile on the device. - GETGetNotefile
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileIDFor .qi files, returns the queued up notes. For .db files, returns all notes in the notefile - POSTAddQiNote
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileIDAdds a Note to a Notefile, creating the Notefile if it doesn't yet exist. - GETGetDbNote
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileID/:noteIDGet a note from a .db or .qi notefile - PUTUpdateDbNote
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileID/:noteIDUpdate a note in a .db or .qi notefile - POSTAddDbNote
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileID/:noteIDAdd a Note to a .db notefile. if noteID is '-' then payload is ignored and empty notefile is created - DELETEDeleteNote
/v1/projects/:projectOrProductUID/devices/:deviceUID/notes/:notefileID/:noteIDDelete a note from a .db or .qi notefile - GETGetDevicePlans
/v1/projects/:projectOrProductUID/devices/:deviceUID/plansGet Data Plans associated with the device, this include the primary sim, any external sim, as well as any satellite connections. - POSTProvisionDevice
/v1/projects/:projectOrProductUID/devices/:deviceUID/provisionProvision Device for a Project - GETGetDevicePublicKey
/v1/projects/:projectOrProductUID/devices/:deviceUID/public-keyGet Device Public Key - GETGetDeviceSessions
/v1/projects/:projectOrProductUID/devices/:deviceUID/sessionsGet Device Sessions - POSTSignalDevice
/v1/projects/:projectOrProductUID/devices/:deviceUID/signalSend a signal from Notehub to a Notecard. - GETGetDevicePublicKeys
/v1/projects/:projectOrProductUID/devices/public-keysGet Device Public Keys of a Project - GETGetFleetDevices
/v1/projects/:projectOrProductUID/fleets/:fleetUID/devicesGet Devices of a Fleet within a Project
billing_account
- GETGetBillingAccounts
/v1/billing-accountsDeprecated. Get Billing Accounts accessible by the api_key - GETGetBillingAccount
/v1/billing-accounts/:billingAccountUIDDeprecated. Get Billing Account Information - GETGetBillingAccountBalanceHistory
/v1/billing-accounts/:billingAccountUID/balance-historyDeprecated. Get Billing Account Balance history
route
- GETGetRoutes
/v1/projects/:projectOrProductUID/routesGet all Routes within a Project - POSTCreateRoute
/v1/projects/:projectOrProductUID/routesCreate Route within a Project - GETGetRoute
/v1/projects/:projectOrProductUID/routes/:routeUIDGet single route within a project - PUTUpdateRoute
/v1/projects/:projectOrProductUID/routes/:routeUIDUpdate route by UID - DELETEDeleteRoute
/v1/projects/:projectOrProductUID/routes/:routeUIDDelete single route within a project - GETGetRouteLogsByRoute
/v1/projects/:projectOrProductUID/routes/:routeUID/route-logsGet Route Logs by Route UID
webhook
- POSTCreateLegacyWebhookEvent
/v1/products/:productUID/devices/:deviceUID/webhook-eventLegacy endpoint for sending an event from a webhook, associated with the given device (provisioning it if necessary). The request body is a Note-shaped object… - PUTUpdateLegacyWebhookSession
/v1/products/:productUID/devices/:deviceUID/webhook-sessionLegacy endpoint for opening or updating a webhook session for the given device (provisioning the device if necessary). Used by external services that need to… - POSTCreateWebhookDeviceEventByProduct
/v1/products/:productUID/webhooks/:webhookUID/devices/:deviceUID/eventSends an event to be processed by the specified webhook, addressed by productUID, associated with the given device (provisioning it if necessary). The entire… - POSTCreateWebhookEventByProduct
/v1/products/:productUID/webhooks/:webhookUID/eventSends an event to be processed by the specified webhook, addressed by productUID. The entire request body becomes the event body. The webhook's configured… - GETGetWebhookSettingsByProduct
/v1/products/:productUID/webhooks/:webhookUID/settingsRetrieves the configuration settings for the specified webhook, addressed by productUID. - PUTUpdateWebhookSettingsByProduct
/v1/products/:productUID/webhooks/:webhookUID/settingsUpdates the configuration settings for the specified webhook, addressed by productUID. Update body will completely replace the existing settings. - GETGetWebhooks
/v1/projects/:projectOrProductUID/webhooksRetrieves all webhooks for the specified project - GETGetWebhook
/v1/projects/:projectOrProductUID/webhooks/:webhookUIDRetrieves the configuration settings for the specified webhook - PUTUpdateWebhook
/v1/projects/:projectOrProductUID/webhooks/:webhookUIDUpdates the configuration settings for the specified webhook. | Webhook will be created if it does not exist. Update body will completely replace the existing… - POSTCreateWebhook
/v1/projects/:projectOrProductUID/webhooks/:webhookUIDCreates a webhook for the specified product with the given name. The name | must be unique within the project. - DELETEDeleteWebhook
/v1/projects/:projectOrProductUID/webhooks/:webhookUIDDeletes the specified webhook
external devices
- POSTCreateEventExtDevice
/v1/products/:productUID/ext-devices/:deviceUID/eventCreates an event using specified webhook - POSTExtDeviceSessionClose
/v1/products/:productUID/ext-devices/:deviceUID/session/closeCloses the session for the specified device if open - POSTExtDeviceSessionOpen
/v1/products/:productUID/ext-devices/:deviceUID/session/openCreate a Session for the specified device. | If a session is currently open it will be closed and a new one opened.
usage
- GETGetApiUsage
/v1/projects/:projectOrProductUID/usage/api?period=dayGet billable Notehub API request usage for a project, broken down by endpoint and time period, when endDate is 0 or unspecified the current time is implied.… - GETGetDataUsage
/v1/projects/:projectOrProductUID/usage/data?period=dayGet data usage in bytes for a project with time range and period aggregation - GETGetEventsUsage
/v1/projects/:projectOrProductUID/usage/events?period=dayGet events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied - GETGetRouteLogsUsage
/v1/projects/:projectOrProductUID/usage/route-logs?period=dayGet route logs usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied - GETGetSessionsUsage
/v1/projects/:projectOrProductUID/usage/sessions?period=dayGet sessions usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
jobs
- GETGetJobs
/v1/projects/:projectOrProductUID/jobsList all batch jobs for a project - POSTCreateJob
/v1/projects/:projectOrProductUID/jobs?name=stringCreate a new batch job with an optional name - GETGetJob
/v1/projects/:projectOrProductUID/jobs/:jobUIDGet a specific batch job definition - DELETEDeleteJob
/v1/projects/:projectOrProductUID/jobs/:jobUIDDelete a batch job - POSTRunJob
/v1/projects/:projectOrProductUID/jobs/:jobUID/runExecute a batch job - GETGetJobRuns
/v1/projects/:projectOrProductUID/jobs/:jobUID/runsList all runs for a specific job - GETGetJobRun
/v1/projects/:projectOrProductUID/jobs/runs/:reportUIDGet the result of a job execution - DELETEDeleteJobRun
/v1/projects/:projectOrProductUID/jobs/runs/:reportUIDDelete the results of a job run - POSTCancelJobRun
/v1/projects/:projectOrProductUID/jobs/runs/:reportUID/cancelCancel a running job execution
description
- GETListGlobalDescriptions
/v1/descriptionList metadata for all global description records. - GETGetGlobalDescription
/v1/description/:descriptionNameGet a global description record. Returns the raw content with its stored Content-Type. - POSTSetGlobalDescription
/v1/description/:descriptionNameCreate or replace a global description record, Blues staff only (up to 10MB). The request Content-Type is stored and returned on GET; when omitted it is… - DELETEDeleteGlobalDescription
/v1/description/:descriptionNameDelete a global description record by name (Blues staff only). - GETListProjectDescriptions
/v1/projects/:projectOrProductUID/descriptionList metadata for all description records in a project. - GETGetProjectDescription
/v1/projects/:projectOrProductUID/description/:descriptionNameGet a project description record. Returns the raw content with its stored Content-Type. - POSTSetProjectDescription
/v1/projects/:projectOrProductUID/description/:descriptionNameCreate or replace a project description record (up to 10MB). The request Content-Type is stored and returned on GET; when omitted it is detected (JSON or text). - DELETEDeleteProjectDescription
/v1/projects/:projectOrProductUID/description/:descriptionNameDelete a project description record by name.
alert
- GETGetAlerts
/v1/projects/:projectOrProductUID/alertsGet list of defined Alerts
monitor
- GETGetMonitors
/v1/projects/:projectOrProductUID/monitorsGet list of defined Monitors - POSTCreateMonitor
/v1/projects/:projectOrProductUID/monitorsCreate a new Monitor - GETGetMonitor
/v1/projects/:projectOrProductUID/monitors/:monitorUIDGet Monitor - PUTUpdateMonitor
/v1/projects/:projectOrProductUID/monitors/:monitorUIDUpdate Monitor - DELETEDeleteMonitor
/v1/projects/:projectOrProductUID/monitors/:monitorUIDDelete Monitor
API details
- Base URL
https://api.notefile.net- Authentication
- A bearer token in the Authorization header
- Operations
- 137 operations on 97 pathsGET 71POST 33DELETE 19PUT 14
3 marked deprecated - Main resources
- project 45device 31webhook 11jobs 9description 8route 6event 5monitor 5usage 5billing_account 3
- Response formats
application/jsonapplication/octet-stream- Description format
- OpenAPI 3.0.3, API version
1.2.0 - Links
- Documentation · OpenAPI document · Support
- Listed from
- Blues's published OpenAPI description (blues/notehub-js) (MIT)
How to test the Notehub API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Notehub API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Login” (POST /auth/login), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Notehub API?
The OpenAPI definition for the Notehub.io API. It is listed under IoT & devices and has 137 endpoints.
Who publishes the Notehub API?
It is listed from Blues's public API description (an OpenAPI document), not published by Blues on Swastik Codes. Anyone who controls blues.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Notehub API?
Requests go to https://api.notefile.net. Endpoint paths are added to this base URL.
How do I authenticate with the Notehub API?
With A bearer token in the Authorization header.
How many endpoints does the Notehub API have?
137 operations on 97 paths (71 GET, 33 POST, 19 DELETE, 14 PUT). The largest groups are project, device, webhook, jobs.
Is forking the Notehub API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.