File Upload API

This API provides access to upload file content as instance, plugin, module or store item.

The filename shall use one of this supported file endings:

EndingDescription

.instance.json

A JSON instance configuration file.

.plugin.js

A JavaScript plugin file. The filename1 is used as the plugin ID.

.js

A JavaScript module file. The filename1 is used as the module name.

.store.txt

A plain text file for a store item. The filename1 is used as the key.

1 Without file ending.

POST /upload/file

JSON Request

PropertyTypeDescription
fileContainer

FileContainer

The file container object.

FileContainer

PropertyTypeDescription
filename

string

The filename with a supported file ending.

content

string

UTF8 encoded file content.

BAD_REQUEST (400) Response

PropertyTypeDescription
message

string

A detailed error message.