Skip to main content
GET
TRMNL device setup

Response

OK

Response to GET /api/setup/.

The TRMNL firmware persists api_key to flash and uses it on every subsequent call. image_url is the first image to paint — for an unclaimed device this is the fallback "register me" screen.

api_key
string
required

Opaque per-device access token. Firmware stores this in flash and sends it in the Access-Token header on every subsequent call.

friendly_id
string
required

Short 6-character human-readable device label (e.g. A1B2C3). Shown on the panel during first-boot and used in dashboard URLs.

image_url
string
required

Absolute URL the device should fetch to paint its first image. For an unclaimed device this points to the BYOS fallback image.

filename
string
required

Suggested filename for the device to use when caching the fetched image locally.

message
string
default:""

Optional human-readable message — currently always empty on success. Future: post-firmware-update notes.

status
integer
default:200

TRMNL setup status code. Always 200 on success; 404 on devices that should refuse to operate (currently unused).