RequestRocketRequestRocketDocs
ObserveAlerts

Alerts with an agent

Create a standalone alert on a proxy.

Use a standalone alert when the condition is independent of a rule, filter, override, meter, or transform. An enabled policy requires a cadence.

Call get_guide with guide_key: "alert-creation" before the first create.

Call order

  1. Call create_proxy_alert.
    • Required: clientId, proxyId, alertActive, alertMode, alerts.
    • Optional: effect, priority, notes, methods, path, headers, query, body, token, responseHeaders, responseBody, responseStatus, variables.
  2. Keep the returned alert sKey.
  3. Call get_proxy_alert(clientId, proxyId, alertId) to verify it.

list_proxy_alerts requires clientId and proxyId. update_proxy_alert also requires alertId; all configuration fields are optional.

Example

{
  "tool": "create_proxy_alert",
  "arguments": {
    "clientId": "b3a1c7d2-5e44-4f0a-9c1e-7d2f8a6b1c90",
    "proxyId": "5d8a1c30-4e72-4b19-8f6a-0c3d9e7b1a25",
    "alertActive": true,
    "alertMode": "conditional",
    "responseStatus": [
      {
        "value": { "pattern": "^429$" },
        "presence": "must_exist"
      }
    ],
    "alerts": {
      "enabled": true,
      "cadence": "hour",
      "alertNote": "Rate-limited calls"
    }
  }
}

Matching calls are aggregated into the next closed hourly digest, persisted as an organisation alert, and emailed to organisation members.

Next

On this page