Server Ban → Get
AI-generatedSummary
Retrieve detailed information about a specific server ban on the UnrealIRCd server by specifying its ban mask/name and type.
Inputs
- Ban Name/Mask (required) — The ban mask or name identifying the specific ban to retrieve, e.g., '@.example.com'.
- Ban Type (required) — The type of the ban to retrieve, chosen from G-line (global), K-line (local), Z-line (IP), or Q-line (nickname) bans.
- Object Detail Level — The level of detail in the returned ban information, specified as a number from 0 to 7; higher values provide more details.
- Redaction Options — Options to redact sensitive information from the response, including toggles to redact sensitive data and IP addresses.
Output shape
a single record containing detailed information about the specified server ban
The response includes ban details according to the requested detail level and applies redactions if specified. The output JSON field 'result' holds the ban details; errors are returned if the ban is not found or inputs are invalid.