alerts

Update Alert Rule Route

Changed on
patch/api/v1/alert-rules/{rule_id}

Request

  • Base URL
    https://cp.xenovia.io (the document declares no server; this is the origin it was published from)
  • URL
    https://cp.xenovia.io/api/v1/alert-rules/{rule_id}
  • Auth
    none declared

Path parameters

rule_idstring uuid required

Headers

Authorizationstring nullable

Request body

namestring nullable
trigger_type'policy_block' | 'policy_redact' | 'policy_escalate' | 'guardrail_escalate' | 'guardrail_block' | 'high_latency' | 'high_intent_score' | 'run_error' | 'fallback_served' | 'fallbacks_exhausted' | 'turn_blocked' | 'turn_escalated' | 'turn_error' | 'compliance_check_failing' nullable
thresholdnumber nullable
severity'info' | 'warning' | 'critical' nullable
cooldown_secondsinteger nullable
operator'gt' | 'gte' | 'lt' | 'lte' nullable
window_seconds300 | 900 | 3600 | 86400 nullable
aggregationstring nullable
min_samplesinteger nullable
channelsstring[] nullable
agent_idstring uuid nullable
enabledboolean nullable

Response

Successful Response

idstring uuid required
org_idstring uuid required
agent_idstring uuid nullable required
namestring required
kindstring required
trigger_typestring nullable required
thresholdnumber nullable required
severitystring required
cooldown_secondsinteger required
metricstring nullable required
aggregationstring nullable required
operatorstring nullable required
window_secondsinteger nullable required
group_bystring nullable required
min_samplesinteger required
filtersobject required
channelsstring[] required
enabledboolean required
created_bystring uuid nullable required
created_atstring date-time required
updated_atstring date-time nullable required

Changes

  • b475b750a0b7Revision changes
    • info

      added the new fallback_served enum value to the request property /

    • info

      added the new fallbacks_exhausted enum value to the request property /

  • 2f4b4b338b8fRevision changes
    • info

      added the new compliance_check_failing enum value to the request property /