automod_get_rule
automod_get_rule
Section titled “automod_get_rule”Category: automod
Fetch a single AutoMod rule.
When to use
Section titled “When to use”- Inspect rule config before editing.
When NOT to use
Section titled “When NOT to use”| Field | Type | Required | Description |
|---|---|---|---|
guild_id | string | yes | Guild containing the rule |
rule_id | string | yes | AutoMod rule to fetch |
Returns
Section titled “Returns”full rule shape. name and trigger_metadata keyword_filter / regex_patterns are user-authored — wrapped untrusted.
Output schema
Section titled “Output schema”| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | Discord AutoMod rule ID |
name | string | yes | |
creator_id | string | yes | Discord user ID |
event_type | integer | yes | |
trigger_type | integer | yes | |
trigger_metadata | object | no | |
actions | array | yes | |
enabled | boolean | yes | |
exempt_roles | array | yes | |
exempt_channels | array | yes | |
untrusted_text | string | yes |
Annotations
Section titled “Annotations”| Property | Value |
|---|---|
| Read-only | yes |
| Destructive | no |
| Idempotent | yes |
| Open-world | yes |
| Confirmation required | no |