engine
State of the engine, speed limits, log and events; stopping njMule.
GET /status
Connections, speeds and counters of the engine.
GET /limits
The speed limits.
PUT /limits
Changes the speed limits; a limit left out stays as it is.
GET /preferences
The passwords, of the proxy and of the mail server, are never given; /preferences/passwords tells which are set.
PATCH /preferences
An unknown key or a wrong value changes nothing, and the error names the key. Ports, UPnP, the proxy and the network interface take effect when njMule connects again.
GET /preferences/passwords
By the keys of the passwords, proxy.password and notify.smtpPassword. Changing the preferences replaces a password, and an empty one clears it.
GET /preferences/defaults
Every preference as it is before anyone changes it, written as the preferences are.
GET /folders
The folders the engine uses, the defaults of those the preferences leave empty included.
POST /folders/check
A folder the options name need not exist yet, as it is made when it is needed; a file, or text that is no path there, cannot be one.
GET /interfaces
Those up now, with an IPv4 address, the loopback left out. The preference net.bindInterface names one by its name, or one of its addresses.
GET /webui
The password hashes are never given, only whether there are passwords.
PATCH /webui
Only the desktop app's window on njMule's computer may: a browser's session or a caller with the API token is refused. A wrong value, or an interface turned on without a password, changes nothing.
GET /webui/token
The API token, made now if there is none; for the desktop app's window on njMule's computer only.
POST /webui/token
Replaces the API token, whose holders are refused from now on; for the desktop app's window only.
GET /desktop
A setting the system or this installation does not offer is null, such as one of a development build.
PATCH /desktop
What the body names changes; the rest stays. Giving the links up gives them back to the program that opened them before. A setting the system does not offer is refused, and nothing changes.
GET /schedule
The rules that change limits at the times they name, and the one that applies now.
PUT /schedule
Replaces the rules of the schedule.
GET /rates
The transfer rates of the last minutes or of the last day, as njMule sampled them.
GET /import/emule
The configuration folder of an eMule on njMule's computer, where eMule keeps it.
POST /import/emule
Servers, Kad contacts, known and shared files and the preferences are taken over; ports and folders stay njMule's own. A check (dryRun, the default) changes nothing.
GET /import/emule/history
The searches and the server list addresses of the eMule whose profile was imported, as the import kept them, the newest first; empty lists before an import.
GET /setup
The start that created njMule's configuration marks it to be set up; it stays so, across starts, until an interface asks the questions and `POST /setup/done` says they were answered or put aside.
POST /setup/done
Marks the questions of the first start answered or put aside.
POST /ipfilter
Replaces the IP filter with the list at an address.
POST /ipfilter/lists
Replaces the IP filter with the lists of the preferences, joined into one.
GET /log
The latest lines of the log, oldest first.
GET /events
Each event's `event` field is its name, `data` its JSON and `id` its number in the stream.
POST /shutdown
Stops njMule.
POST /notifications/test
Sends a test message through each notification channel that is on, and tells how each went.
GET /ports/test
The last test of the ports, or null before the first.
POST /ports/test
The test goes on after the answer; read it again until done.