Get Server
AI-generatedSummary
Retrieve detailed information about a specific IRC server on the UnrealIRCd network, optionally redacting sensitive data and IP addresses, with configurable detail level.
Inputs
- Server Name (required) — The IRC server name to target for information retrieval.
- Redaction Options — Options to redact sensitive data (default true) and IP addresses (default true) from the response for privacy.
- Object Detail Level — Sets the level of detail included in the response, an integer from 0 (least) to 7 (most), defaulting to 2.
Output shape
a single JSON object containing detailed server information per the requested detail level, with sensitive data/IPs redacted as specified
The returned JSON includes fields describing the targeted IRC server details. Redaction options affect whether sensitive fields like IP addresses are omitted or masked. The detail level controls the amount of information included. Errors return an error message and success=false.
Examples
Example 1: Get detailed info on server 'irc.example.net' with default redaction and detail level
Server Name: irc.example.net; Redact Sensitive Data: true; Redact IPs: true; Object Detail Level: 2