Get Custom Rule

Return the full editable definition for a customer-owned custom rule

GET /api/policies/rules/{rule_id}

Get Custom Rule

cURL

curl --request GET \
  --url https://api.zerodrift.ai/api/policies/rules/{rule_id} \
  --header 'x-api-key: <api-key>'

200

{
  "rule_id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "action": "<string>",
  "severity": "<string>",
  "suggested_text": "<string>",
  "source": "<string>",
  "active": true,
  "fix_note": "<string>",
  "prompt": "<string>",
  "keywords": [
    {}
  ],
  "window": "<string>",
  "regex_pattern": "<string>",
  "anchor": "<string>",
  "near": [
    {}
  ],
  "distance_chars": 123,
  "direction": "<string>",
  "case_insensitive": true,
  "mode": "<string>",
  "min_hits": 123,
  "import_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Return the full editable definition for a customer-owned custom rule.

Path Parameters

rule_id · string · required

Custom rule identifier (typically prefixed with cust_)

Response

rule_id · string

Rule identifier

name · string

Human-readable rule name

type · string

AI_SIGNAL, REGEX, or REQUIRE_NEAR

action · string

fix or flag

severity · string

do_not_send or send_with_caution

suggested_text · string

Stored suggested replacement or warning guidance when present

source · string

Always custom

active · boolean

Whether the rule currently runs during validation

fix_note · string

Remediation guidance when present

prompt · string

AI instruction (AI_SIGNAL only)

keywords · array

Keyword gate (AI_SIGNAL only)

window · string

sentence, paragraph, or document (AI_SIGNAL only)

regex_pattern · string

Regex pattern (REGEX only)

anchor · string

Anchor regex (REQUIRE_NEAR only)

near · array

Near-pattern regexes (REQUIRE_NEAR only)

distance_chars · integer

Character distance (REQUIRE_NEAR)

direction · string

before, after, or either (REQUIRE_NEAR)

case_insensitive · boolean

Case-insensitive matching (REQUIRE_NEAR)

mode · string

document or page (REQUIRE_NEAR)

min_hits · integer

Minimum near hits (REQUIRE_NEAR)

import_id · string

Source import ID when the rule was created via policy import

created_at · string

ISO 8601 creation timestamp

updated_at · string

ISO 8601 last-update timestamp when present

Errors

Status	Meaning
403	Forbidden
404	Custom rule not found

Example

curl "https://api.zerodrift.ai/api/policies/rules/cust_abc123_no_misleading_claims" \
  -H "x-api-key: YOUR_API_KEY"