TRMNL Octri Demo
POST/api/plugin_settings/{id}/archive

Upload a plugin setting archive

Uploads an archive file for an existing plugin setting. Send the file as multipart/form-data and use the id path parameter to identify the plugin setting. A successful response includes the archive's settings_yaml data.

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

1 parameter
idintegerrequired
The integer identifier of the plugin setting to upload the archive for.

3 status codes
200Returns the uploaded archive data, including `settings_yaml`.
dataobjectoptional
401Returned when the request is unauthorized.
errorstringoptional
422Returned when the archive cannot be processed.
errorstringoptional

Error handling

The id path parameter must identify the plugin setting whose archive you are uploading. A 401 is returned when the request is unauthorized; a 422 is returned when the archive cannot be processed.