Skip to main content
PATCH
Update an alert rule

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

rule_id
string
required

The alert rule id.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Body

application/json
name
string

Display name for the rule.

Maximum string length: 255
Example:

"High gas on eth"

severity
string

Severity label for the rule.

Maximum string length: 255
Example:

"high"

enabled
boolean

Whether the rule is enabled.

Example:

true

parameters
object

Replacement parameter values, as a { field: value } object (arrays are normalized to an object on write). Changing this bumps the rule's version and archives the previous version.

Response

200 - application/json
id
string
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

workspace_id
string
required
Example:

"workspace-123"

rule_type
string
required
Example:

"GasPressure"

severity
string
required
Example:

"high"

parameters
object
required
Example:
trigger
enum<string>
required
Available options:
BLOCK,
TICK
Example:

"BLOCK"

enabled
boolean
required
Example:

true

version
number
required

Incremented each time the rule parameters change. Starts at 1.

Example:

1

subscribed_channels
object[]
required
Example:
created_at
string
required
Example:

"2026-05-14T12:00:00.000Z"

updated_at
string
required
Example:

"2026-05-14T12:00:00.000Z"

name
string | null
Example:

"High gas on eth"

network
string | null
Example:

"eth"

runner_id
string | null
Example:

"alert-runner-eth-v2"

alert_template
object | null
Last modified on July 22, 2026