Read a fleet | TRMNL Octri Demo

1 parameter

installation_idstringrequired

Fleet installation id, from listAppInstallations

3 status codes

200Success

dataobjectoptional

401Unauthorized

errorstringoptional

404Installation belongs to another user

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Installation belongs to another user.

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

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

const result = await client.fleet.get({ installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "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