post/orgs/{orgId}/anomaly-alerts/{alertId}/acknowledge

Request

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

Path parameters

orgIdstring required

Organization identifier

alertIdstring required

Alert identifier

Request body

acknowledgedBystring required

User acknowledging the alert

Response

OK

idstring required

Unique alert identifier

orgIdstring required

Organization identifier

agentIdstring required

Agent identifier

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

Type of metric being tracked

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

Severity level of the anomaly alert

status'TRIGGERED' | 'ACKNOWLEDGED' | 'RESOLVED' | 'FALSE_POSITIVE' required

Current status of the anomaly alert

baselineValuenumber required

Expected baseline value

actualValuenumber required

Observed actual value

zScorenumber required

Z-score of the deviation

ruleIdstring nullable required

Identifier of the rule that triggered this alert

detailsobject required

Additional details about the anomaly

acknowledgedBystring nullable required

User who acknowledged the alert

acknowledgedAtstring nullable required

ISO 8601 timestamp when acknowledged

resolvedBystring nullable required

User who resolved the alert

resolvedAtstring nullable required

ISO 8601 timestamp when resolved

createdAtstring required

ISO 8601 timestamp when alert was created

updatedAtstring required

ISO 8601 timestamp when alert was last updated

Changes

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