Get plugin setting health and recent logs

3 parameters

plugin_setting_idstringrequired

The plugin setting's integer ID, as returned by the listing, or its UUID.

levelstringoptional

Filter logs by level: `debug`, `info`, `warn`, or `error`.

Allowed:debuginfowarnerror

limitintegeroptional

Maximum number of logs to return, from 1 to 50. Defaults to 20 when omitted.

4 status codes

200Returns plugin setting health information, recent logs, and a status for the logs.

dataobjectoptional

401Returned when the request is unauthorized.

errorstringoptional

404Returned when the UUID belongs to another user.

422Returned when the requested level has no matching logs.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the UUID in the plugin_setting_id path parameter belongs to another user, and a 422 is returned when level has no matching logs. level must be debug, info, warn, or error; limit must be from 1 to 50.

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

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

const result = await client.logs.list({
  pluginSettingId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  level: "example",
  limit: 20,
});

{
  "data": {
    "health": {
      "error_message": "example_value",
      "error_retry_count": 0,
      "last_refresh": "example_value",
      "next_refresh": "example_value",
      "state": "active"
    },
    "logs": [
      {
        "dump": [
          {
            "m": "example_value"
          }
        ],
        "event_id": "11111111-1111-4111-8111-111111111111",
        "level": "error",
        "source": "private_plugin",
        "ts": "2026-09-05 12:00:00.000"
      }
    ],
    "logs_status": "available"
  }
}

Request

Response

Errors