UnrealIRCd ChannelInstall

Summary

Retrieve detailed information about a specific UnrealIRCd channel by specifying its name and desired detail level, with optional redaction of sensitive data in the response.

Inputs

• Channel (required) — The exact name of the channel to retrieve details for, e.g. '#channel'.
• Object Detail Level — A number from 0 to 7 indicating the level of detail to include in the returned channel information.
• Redaction Options — Options to redact sensitive information from the channel details response, including toggles for IP addresses, email addresses, and custom regex patterns.

Output shape

a single record representing the requested channel's details

The response JSON object includes the channel information at the requested detail level. If redaction options are enabled, sensitive data such as IPs, emails, and custom patterns will be redacted from the returned data.

Examples

Example 1: Retrieve detailed info of channel #example with redacted IPs and emails

Channel set to '#example', Object Detail Level set to 3, Redact Sensitive Data enabled with IP and Email redaction both true