JSON-RPC

UnrealIRCd has a JSON-RPC API which can be used to have a UnrealIRCd admin panel. The admin panel allows you to see lists and details of users and channels, manage server bans, spamfilters, etc., all from your browser. The JSON-RPC API can also be used by other programs, such as for statistics and other integrations.

This page is for admins to quickly get started with configuring JSON-RPC access (see Configuration below). If you are a developer or technical user, then there is also the JSON-RPC Technical documentation for information on API calls etc.

If you are a JSON fan, then you may also be interested in JSON logging, which is an entirely different topic.

Configuration
You need to load the required JSON-RPC modules. Simply put this in your unrealircd.conf: include "rpc.modules.default.conf";

Then, open up a port (Listen block) and add at least one api user (Rpc-user block): /* HTTPS on port 8600 for the JSON-RPC API */ listen { ip *; port 8600; options { rpc; } }

/* API user */ rpc-user apiuser { match { ip 127.*; } password "password"; }

Current software
The following (external) software uses UnrealIRCd's JSON-RPC API:
 * UnrealIRCd admin panel by Valware (PHP)
 * OpenBNET (D)

Technical documentation and protocol
For developers and people who want to use the JSON-RPC API to interact with UnrealIRCd, see the JSON-RPC:Technical documentation.