Skip to content
Sven Walter edited this page Sep 12, 2016 · 7 revisions

API paths for the restful interface

Endpoint for all requests: /api/v1

Modules

GET /modules/list

returns all registered modules

GET /modules/register

registers a new module to the core

GET /modules/:module

gets information about :module

GET /modules/:module/transit/:path

passes :path directly to the :module

GET /findmodules

lets the backend search for (new) modules returns /getmodules

GET /modules/:module/execute

registers subroutes of :module

Settings

GET /settings

returns all settings of core and all available modules

GET /settings/:module

returns all settings of a specific module

POST /settings/:module/:key

requires a value to set for a scpecifiy setting of a module returns status of Action {"status": status} status is one of

  • MODULE_ERROR
  • KEY_ERROR
  • VALUE_CONTENT_ERROR
  • VALUE_TYPE_ERROR
  • OK
Clone this wiki locally