TRMNL Octri Demo
POST/api/plugin_settings/{plugin_setting_id}/refreshes

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
plugin_setting_idstringrequired
Plugin setting id or uuid

5 status codes
202Queues a render for an instance that does not poll, such as a native plugin
dataobjectoptional
401Unauthorized
errorstringoptional
404UUID belonging to another user
422Instance has no polling URL
429The account has used its hourly render allowance, shared with the dashboard and MCP

Error handling

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