Plugin Settings - Refresh

Refresh a plugin instance

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.

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

Path parameters

plugin_setting_idstring required

Plugin setting id or uuid

Response

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

Example response

{
  "data": {
    "job_id": "3f1e...",
    "status": "pending"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.