API reference

The firmngin API lets your own software work with the devices in your workspace: send commands, read history, provision new units, publish firmware, and receive events.

Base URL

https://api.firmngin.dev

All requests use HTTPS. Request and response bodies are JSON unless a page says otherwise.

Credentials

Credential	Where to get it	Used for
Workspace API token	Dashboard → Integrations → Generate Token	Server-to-server calls: devices, provisioning, firmware
Publishable SDK key + SDK merchantId	Dashboard → Integrations → Browser SDK access	Browser checkout for a Device Billing merchant
Webhook signing secret	Dashboard → Webhooks	Verifying events firmngin sends to you

See Authentication for headers and scopes.

Errors

Failed requests return an HTTP status code and a JSON body with a stable code and a readable message:

{
  "error": "INVALID_TOKEN",
  "message": "Token does not have devices:control scope"
}

Status	Meaning
`400`	The request is missing a field or has an invalid value.
`401`	The token is missing, invalid, revoked, or lacks the required scope.
`402`	The workspace needs a top-up before this action can run.
`403`	The token is not allowed to act on this resource.
`404`	The resource does not exist or belongs to another workspace.
`409`	The resource is in a state that does not allow this action.
`429`	Too many requests. Wait and retry.
`503`	The device is offline or the service is temporarily unavailable.

Pagination

List endpoints accept page (starting at 1) and limit, and return the totals alongside the results.

Dates

Send dates in ISO 8601 format, for example 2026-10-01T00:00:00Z. Responses use UTC.

Firmware flashing

Flash via Third-Party API

Resolve signed firmware, create a single-use download ticket, download the binary, and record a local flash session.

Flash enrollment API

Enroll an installation with an ES256 key and use short-lived DPoP access tokens.

Getting started

Devices

Firmware

Device Billing

Webhooks

Base URL

Credentials

Errors

Dates

Firmware flashing

Flash via Third-Party API

Flash enrollment API

​Base URL

​Credentials

​Errors

​Pagination

​Dates

​Firmware flashing

Flash via Third-Party API

Flash enrollment API

Base URL

Credentials

Errors

Pagination

Dates

Firmware flashing