@PLUGIN@ - /config/ REST API

This page describes the ‘/config/’ REST endpoints that are added by the @PLUGIN@ plugin.

Please also take note of the general information on the REST API.

@PLUGIN@ Endpoints

GET /config/server/@PLUGIN@~config

Gets the configuration of the @PLUGIN@ plugin.

  GET /config/server/@PLUGIN@~config HTTP/1.0

As response a ConfigInfo entity is returned that contains the configuration of the @PLUGIN@ plugin.

  HTTP/1.1 200 OK
  Content-Disposition: attachment
  Content-Type: application/json;charset=UTF-8

  )]}'
  {
    "show_emoticons": true
  }

PUT /config/server/@PLUGIN@~config

Sets the configuration of the @PLUGIN@ plugin.

The new configuration must be specified as a ConfigInfo entity in the request body. Not setting a parameter leaves the parameter unchanged.

  PUT /config/server/@PLUGIN@~config HTTP/1.0
  Content-Type: application/json;charset=UTF-8

  {
    "show_emoticons": true
  }

The ConfigInfo entity contains the configuration of the @PLUGIN@ plugin.