UnrealIRCd BanInstall

Summary

Retrieve a list of server bans (such as G-lines, K-lines, Z-lines, or Q-lines) configured on the UnrealIRCd server, optionally controlling the detail level and redacting sensitive data from the response.

Inputs

• Redaction Options — Configure whether to redact sensitive information and IP addresses from the returned ban data. 'Redact Sensitive Data' enables redaction, with 'Redact IP Addresses' controlling IP-specific redaction when enabled.
• Object Detail Level — Specify the detail level of ban objects returned, ranging from 0 (minimal) to 7 (most detailed); defaults to 2.

Output shape

a single JSON object containing an array of server bans with details depending on the specified detail level and redaction settings.

Response structure depends on the 'Object Detail Level' parameter. If redaction is enabled, sensitive fields (like IP addresses) may be removed or masked. The operation returns an envelope with 'resource', 'operation', 'success', and 'result' fields, where 'result' contains the list of bans.

Examples

Example 1: List all server bans with default detail level and IP redaction enabled

Set 'Redact Sensitive Data' to false (default), so IP addresses remain visible; 'Object Detail Level' at 2 (default). The returned list includes ban entries with moderate detail.

Example 2: List server bans with maximum detail and sensitive data redacted

Enable 'Redact Sensitive Data' and 'Redact IP Addresses' to hide sensitive fields including IPs; set 'Object Detail Level' to 7 for maximum detail on each ban entry.