Device API

Set up device

Please note that the returned status JSON value may NOT always equal the HTTP status code. Notably, if a device MAC address is not found, then the HTTP status code will be 200 but the status code in the response will be 404.

get/api/setup

Request

  • Base URL: https://trmnl.com
  • URL: https://trmnl.com/api/setup
  • Auth: none declared. Required headers: ID, Model

Headers

IDstring required

Device MAC Address (eg. 41:B4:10:39:A1:24)

Modelstring required

DEVICE_MODEL from firmware definitions

Panel-Revstring

Identifier of the ePaper panel fitted to the device

Response

Success

statusinteger
api_keystring nullable
friendly_idstring nullable
image_urlstring nullable
messagestring

Example response

{
  "status": 200,
  "api_key": "abc-123",
  "friendly_id": "ABC-123",
  "image_url": "https://trmnl.com/images/system_screens/setup_logo/og_plus.png",
  "message": "Register at trmnl.com/start with Device ID 'ABC-123'"
}

Changes

No recorded changes to this operation across all 1 revision of this API.