PATCH /api/alerts/{id} · API reference · Antimatter

PATCH/api/alerts/{id}Signed in session

Parameters

Path and query parameters
Field	Type	What it is
id (path)required	integer	The rule id.

Answer 200

The updated rule.

Fields of the 200 answer
Field	Type	What it is
rule	AlertRule
rule.id	integer
rule.name	string
rule.metric	string	One of "spend", "error_rate", "ttft_p95".
rule.threshold	integer	Micro USD, basis points, or milliseconds, by metric.
rule.windowMinutes	integer
rule.minSamples	integer	How many requests the window needs before the number is believed.
rule.scopeModel	string or null
rule.scopeKeyId	integer or null
rule.enabled	boolean
rule.state	string	One of "ok", "firing".
rule.lastValue	integer or null	Null when the last check found nothing to measure.
rule.lastCheckedAt	integer or null
rule.lastTriggeredAt	integer or null
rule.createdAt	integer
rule.updatedAt	integer

Errors

400OpenAI shaped error.
401OpenAI shaped error.
404OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.