v1

latestOpenAPI 3.0.02026-07-26117198177.4 KB
Alert Rules

List alert rules for the caller workspace

Returns every active alert rule that belongs to your workspace. Filter by network, severity, or a name search.

get/v1/risk/alert-rules

Query parameters

networkstring
Example:eth,sol

Comma-separated list of network slugs to filter by (e.g. eth,sol).

severitystring
Example:high

Comma-separated list of severity levels to filter by (e.g. low,medium,high).

search_stringstring
Example:high gas

Case-insensitive search string matched against rule name.

Response

Example response

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "workspace_id": "workspace-123",
      "name": "High gas on eth",
      "rule_type": "GasPressure",
      "network": "eth",
      "severity": "high",
      "parameters": {
        "threshold": 90
      },
      "trigger": "BLOCK",
      "enabled": true,
      "version": 1,
      "subscribed_channels": [
        {
          "alert_channel_id": "44444444-4444-4444-4444-444444444445",
          "min_severity": null
        }
      ],
      "runner_id": "alert-runner-eth-v2",
      "created_at": "2026-05-14T12:00:00.000Z",
      "updated_at": "2026-05-14T12:00:00.000Z",
      "alert_template": {
        "id": "1",
        "type": "large_transfer",
        "label": "Large Transfer",
        "description": "A large transfer was detected on {{network}}",
        "network": "eth",
        "severity": "high",
        "tags": [
          "defi",
          "transfer"
        ],
        "trigger": "BLOCK",
        "parameters": [
          {
            "label": "Wallet",
            "description": "The address to monitor",
            "field": "address",
            "field_type": "Address"
          }
        ]
      }
    }
  ]
}