---
title: "Read plugin instance health and recent logs"
method: GET
path: "/api/plugin_settings/{plugin_setting_id}/logs"
tags: ["Plugin Settings - Logs"]
---

# Read plugin instance health and recent logs

`GET /api/plugin_settings/{plugin_setting_id}/logs`

## Request

- Base URL: `https://trmnl.com`
- URL: `https://trmnl.com/api/plugin_settings/{plugin_setting_id}/logs`
- Auth: HTTP bearer

## Path parameters

- `plugin_setting_id` string, required

## Query parameters

- `level` string
- `limit` integer

## Response `200`

Accepts the integer id the listing returns, as well as the uuid

- object
  - `data` object
    - `health` object
      - `state` string
      - `error_message` string, nullable
      - `error_retry_count` integer, nullable
      - `last_refresh` string, date_time, nullable
      - `next_refresh` string, date_time, nullable
    - `logs_status` 'available' | 'unavailable': Unavailable when the log store cannot be read; logs is then empty
    - `logs` object[]
      - `event_id` string
      - `ts` string
      - `level` string
      - `source` string, nullable
      - `dump` object[], nullable
        - `m` string

## Other responses

- `401`: Unauthorized
- `404`: UUID belonging to another user
- `422`: A level the logs do not have

---

[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)
