UnrealIRCd BanInstall

Summary

Add a new ban to the UnrealIRCd server with specified mask, type, and optional details such as reason, duration, and who set the ban.

Inputs

• Ban Name/Mask (required) — The ban mask or name (e.g., @.example.com)
• Ban Type (required) — The type of ban to add; one of G-line (Global ban), K-line (Local ban), Z-line (IP ban), or Q-line (Nick ban)
• Ban Options — Optional parameters for the ban, including 'Reason' for the ban, 'Duration' (e.g., '1h', '1d'), and 'Set By' indicating who set the ban
• Redaction Options — Options to redact sensitive data from responses, including 'Redact Sensitive Data' (boolean) and if enabled, 'Redact IP Addresses' (boolean)

Output shape

a single JSON object indicating success with the added ban details

The output JSON under the 'result' field includes the response from the server upon adding the ban. Redaction options affect sensitive data visibility in the response.

Examples

Example 1: Add a G-line global ban for *@*.example.com for 1 day with reason and author specified, redacting sensitive data but not IP addresses.

Ban Name/Mask='@.example.com', Ban Type='gline', Ban Options={Reason='Spamming', Duration='1d', Set By='admin'}, Redaction Options={Redact Sensitive Data=true, Redact IP Addresses=false}