View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0006607 | unreal | documentation | public | 2026-01-30 00:07 | 2026-01-30 07:53 |
| Reporter | adator | Assigned To | syzop | ||
| Priority | normal | Severity | minor | Reproducibility | always |
| Status | resolved | Resolution | fixed | ||
| Product Version | 6.2.2 | ||||
| Fixed in Version | 6.2.3 | ||||
| Summary | 0006607: Documentation update | ||||
| Description | Hello team, in the documentation of the connthrottle.set, you've said that we should use action = on in the parameter. while it works well when you provide : enabled : true or false | ||||
| Steps To Reproduce | { "jsonrpc": "2.0", "method": "connthrottle.set", "params": {"action": "on"}, "id": 123 } output: { "jsonrpc": "2.0", "method": "connthrottle.set", "id": 123, "error": { "code": -32602, "message": "Missing parameter: 'enabled'" } } | ||||
| 3rd party modules | |||||
|
|
For the set stuff not working, I'll do that in 0006608. As for documentation / variable names / properties / etc: In current git several changes were done on Dec 14, 2025. Notably this one: https://github.com/unrealircd/unrealircd/commit/ded89d1935f51df3a825c5ab2857d665314384c2 I should update the documentation :) |
|
|
I've done the throttle.set change, what you mentioned in this bug report, in https://www.unrealircd.org/docs/JSON-RPC:Connthrottle#connthrottle.set And I see i had already updated connthrottle.status with the new 6.2.3 style. |
|
|
Have added this comment at the top of that docs page: "Below is the API for UnrealIRCd 6.2.3+. In UnrealIRCd 6.2.2 there also was a preliminary API but in 6.2.2 connthrottle.set did not work and connthrottle.status used different fields / a different structure. " Can be removed in 2027 or something, but useful at the moment. |
|
|
As said, updated the connthrottle.set docs, added the UnrealIRCd 6.2.2 warning. I also updated https://www.unrealircd.org/docs/JSON-RPC:Connthrottle#Response to include more info on a few fields (6.2.3+), this is what I added: Most of these fields should speak for themselves, but some additional info: * '''enabled''': if this is false, the entire module is disabled (THROTTLE OFF) and won't monitor nor take any action * '''state''' can be one of ** <code>monitoring</code>: module is actively monitoring but not blocking anyone (normal operations) ** <code>throttling</code>: module is actively throttling connections (under attack) ** <code>disabled_by_oper</code>: module is disabled (THROTTLE OFF) ** <code>start_delay</code>: server just booted up (set::connthrottle::disabled-when::start-delay), module will not monitor nor take any action. ** <code>reputation_gathering</code>: server is relatively new and does not have a good database with reputation scores yet (set::connthrottle::disabled-when::reputation-gathering), module will not monitor nor take any action. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2026-01-30 00:07 | adator | New Issue | |
| 2026-01-30 07:33 | syzop | Note Added: 0023607 | |
| 2026-01-30 07:43 | syzop | Note Added: 0023609 | |
| 2026-01-30 07:44 | syzop | Note Added: 0023610 | |
| 2026-01-30 07:52 | syzop | Assigned To | => syzop |
| 2026-01-30 07:52 | syzop | Status | new => resolved |
| 2026-01-30 07:52 | syzop | Resolution | open => fixed |
| 2026-01-30 07:52 | syzop | Fixed in Version | => 6.2.3 |
| 2026-01-30 07:52 | syzop | Note Added: 0023611 | |
| 2026-01-30 07:53 | syzop | Note Edited: 0023611 |
