---
title: "Set up device"
method: GET
path: "/api/setup"
tags: ["Device API"]
---

# Set up device

`GET /api/setup`

## Request

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

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.

## Headers

- `ID` string, required
- `Model` string, required
- `Panel-Rev` string

## Response `200`

Success

- object
  - `status` integer
  - `api_key` string, nullable
  - `friendly_id` string, nullable
  - `image_url` string, nullable
  - `message` string

---

[API](https://skmtc.dev/trmnl/apis/trmnl-api.md) · [All operations](https://skmtc.dev/trmnl/apis/trmnl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/trmnl/apis/trmnl-api/revisions/66179e6d663b?raw)