/list

Read the list of available base-config variable definitions. The list is compiled dynamically from fylr's fixed core config items plus any items contributed by loaded plugins, so it varies with the installed plugin set. It describes the config schema (the items a frontend renders into a config form); the stored values are read and written through /config. Requires the system.config system right (system.root always satisfies it).

GET /config/list — Get config list

Get config list

get

The list is a dynamic compilation of available config varibles. It includes fixed config variables of FYLR's base config as well as variables provided by plugins.

Authorizations

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Responses

200

Success

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks the system.config system right (system.root always satisfies it). code is SystemRightRequired.

application/json

{
  "system": {
    "defs": [
      {
        "name": "text",
        "group": "text",
        "parameters": {
          "position": 1,
          "type": "text",
          "name": "text",
          "default": true
        },
        "require_system_right": "text",
        "unauthenticated_visible": true,
        "unavailable": true
      }
    ]
  },
  "plugin": {
    "ANY_ADDITIONAL_PROPERTY": {
      "defs": [
        {
          "name": "text",
          "group": "text",
          "parameters": {
            "position": 1,
            "type": "text",
            "name": "text",
            "default": true
          },
          "require_system_right": "text",
          "unauthenticated_visible": true,
          "unavailable": true
        }
      ]
    }
  }
}