config_get

Fetch the server’s configuration. An admin panel uses this to show current settings before changing them with config_update.

Request

{
  "cmd": "config_get"
}

No fields besides cmd.

Response

{
  "cmd": "config_get",
  "config": {
    "server": {
      "name": "My community",
      "owner": { "name": "alice" },
      "url": "https://chat.example.com",
      "icon": "icon.png"
    },
    "limits": {
      "post_content": 2000,
      "search_results": 30,
      "max_reactions_per_message": 20,
      "max_members": 0
    },
    "attachments": {
      "storage": "s3",
      "s3": {
        "bucket": "chat-uploads",
        "access_key_id": "***",
        "secret_access_key": "***"
      }
    },
    "auth_mode": "rotur",
    "plugins": {}
  }
}

The example is trimmed. config is the contents of config.json merged over the built-in defaults, so every setting appears even if it was never saved. See configuration for each setting.

• Any key named secret_access_key, access_key_id, password, token, secret, validator, or password_hash, at any depth, is replaced with "***".
• server.icon and server.banner hold the stored value, which may be an asset name rather than a full URL.
• plugins doesn’t echo JavaScript plugin settings saved under plugins.<name>. It lists settings only for in-process server plugins, and the server ships none, so it’s an empty object.

Nobody else receives anything.

Permissions

Requires manage_config. It still works while you are timed out.

Errors

Only the generic authentication and permission errors described in the protocol model.

See also

• config_update
• Configuration