Set the fleet master device | TRMNL Octri Demo

1 parameter · 1 body field

installation_idstringrequired

The unique identifier of the fleet installation to update.

The device to promote to master.

device_idintegerrequired

The integer identifier of the device to set as the fleet master.

4 status codes

200Returns the updated fleet data, including its master device, mirror count, and settings and alert information.

dataobjectoptional

401Returned when the request is unauthorized.

errorstringoptional

404Returned when the device belongs to another user.

422Returned when the device is in another fleet.

Error handling

A 401 is returned when the request is unauthorized; a 404 is returned when the device belongs to another user; a 422 is returned when the device is in another fleet. The installation_id path parameter identifies the fleet, and device_id is required and must be an integer.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.master.update({
  installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  deviceId: 5185,
});

{
  "data": {
    "alerts": {
      "email": "user@example.com",
      "enabled": true,
      "threshold_minutes": 60
    },
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "inherited_settings": [
      "refresh_interval"
    ],
    "last_pushed_at": "example_value",
    "master": {
      "check_in_state": "overdue",
      "device_id": 123,
      "expected_check_in_at": "example_value",
      "in_sync": true,
      "last_pushed_at": "example_value",
      "name": "Lobby",
      "role": "master"
    },
    "mirror_count": 3,
    "name": "Fleet",
    "needs_push_count": 1,
    "overdue_count": 0
  }
}

Request

Response

Errors