---
title: "Refresh a plugin instance"
method: POST
path: "/api/plugin_settings/{plugin_setting_id}/refreshes"
tags: ["Plugin Settings - Refresh"]
---

# Refresh a plugin instance

`POST /api/plugin_settings/{plugin_setting_id}/refreshes`

## Request

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

A polling private plugin refetches its URL and answers a job_id to poll with getRefresh. Any other instance queues a render of its current data and answers without one.

## Path parameters

- `plugin_setting_id` string, required

## Response `202`

Queues a render for an instance that does not poll, such as a native plugin

- object
  - `data` object
    - `job_id` string: Only for a polling instance
    - `status` 'pending' | 'queued'
    - `render_in_progress` boolean: Only for a render: another render already holds the instance

## Other responses

- `401`: Unauthorized
- `404`: UUID belonging to another user
- `422`: Instance has no polling URL
- `429`: The account has used its hourly render allowance, shared with the dashboard and MCP

---

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