TRMNL Octri Demo
POST/api/plugin_settings/{plugin_setting_id}/configuration/evaluation

Evaluate a plugin configuration draft

Evaluates a typed draft of plugin configuration without saving it. Provide the current revision and a draft of changes to receive the evaluated configuration and safe field errors. A 409 response indicates the configuration changed while you were preparing the draft.

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

1 parameter · 2 body fields
plugin_setting_idintegerrequired
The identifier of the plugin setting whose configuration draft to evaluate.

The current configuration revision and the typed changes to evaluate.

draftarray<object>required
The draft changes to evaluate. Provide at most 200 entries; each entry requires `op` and `path`.
revisionstringrequired
The revision of the configuration that the draft is based on.

2 status codes
200Returns the evaluated configuration, including values, sections, connections, actions, readiness, and safe field errors.
dataobjectoptional
409Returned when the configuration has changed.

Error handling

A 409 is returned when the configuration has changed; evaluate against the current revision. The draft array can contain at most 200 entries, each with an op of set, unset, or clear_secret and a path beginning with /values/; revision and draft are required. The plugin_setting_id path parameter must identify the plugin setting to evaluate.