patch/orgs/{orgId}/anomaly-rules/{ruleId}

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/orgs/{orgId}/anomaly-rules/{ruleId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

orgIdstring required

Organization identifier

ruleIdstring required

Rule identifier

Request body

namestring
thresholdnumber
severity'INFO' | 'WARNING' | 'CRITICAL'

Severity level of the anomaly alert

quarantineAction'NONE' | 'SOFT' | 'HARD'

Quarantine action to take when rule triggers

cooldownMinutesinteger
enabledboolean

Response

OK

idstring required

Unique rule identifier

orgIdstring required

Organization identifier

namestring required

Human-readable rule name

metric'email_send_rate' | 'sms_send_rate' | 'vault_access_rate' | 'api_call_rate' | 'unique_recipients' required

Type of metric being tracked

condition'zscore_gt' | 'rate_multiplier_gt' | 'absolute_gt' | 'time_violation' required

Detection condition type

thresholdnumber required

Threshold value for the condition

severity'INFO' | 'WARNING' | 'CRITICAL' required

Severity level of the anomaly alert

quarantineAction'NONE' | 'SOFT' | 'HARD' required

Quarantine action to take when rule triggers

cooldownMinutesinteger required

Minutes to wait between alerts for this rule

enabledboolean required

Whether the rule is active

createdAtstring required

ISO 8601 creation timestamp

updatedAtstring required

ISO 8601 last update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.