Eventos de seguridad

Los eventos de seguridad son las peticiones que el borde bloqueó, desafió o registró (WAF, reglas, límites de peticiones, escudos). Todas las rutas comparten los mismos filtros; cada filtro se puede repetir y filtros distintos se combinan con Y.

#Listar eventos

GET /v1/orgs/{org}/zones/{zone}/events

Lista los eventos de seguridad de la zona, del más reciente al más antiguo. Cada filtro se puede repetir (action=block&action=log admite cualquiera de los valores) con como mucho 20 valores; filtros distintos se combinan con Y, y los filtros not_… excluyen los eventos con cualquiera de sus valores. q busca texto (sin distinguir mayúsculas) en el nombre, la ruta, la IP, el método, la regla, el tipo de ataque, el mensaje, el user agent, el país, el id de regla y el estado. Para paginar, pasa next_cursor en cursor.

Rol necesario: readonly o superior.

#Parámetros

#Respuesta

• 200: Devuelve un objeto con los campos de abajo.

#Errores

#Ejemplo

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d/events?action=block&limit=50" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

import { OpenWAF } from "./openwaf";

const owf = new OpenWAF({ baseUrl: "https://dash.openwaf.dev" }); // token de OPENWAF_TOKEN
const result = await owf.listEvents({
  zone: "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d",
  action: "block",
  limit: 50
});

from openwaf import OpenWAF

owf = OpenWAF(base_url="https://dash.openwaf.dev")  # token de OPENWAF_TOKEN
result = owf.list_events(zone="6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d", action="block", limit=50)

{
  "items": [
    {
      "event_id": "8b3e5f7a-1c2d-4e6f-9a0b-3c5d7e9f1a2b",
      "zone_id": "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d",
      "node_id": "edge-node",
      "ts": "2026-10-27T09:29:58Z",
      "host": "www.example.com",
      "ip": "203.0.113.10",
      "method": "POST",
      "path": "/login",
      "status": 429,
      "action": "block",
      "rule_id": 0,
      "rule_name": "rate_rule:login",
      "attack_type": "rate_limit",
      "msg": "",
      "country_code": "ES",
      "asn": 64500,
      "user_agent": "Mozilla/5.0",
      "tls_fingerprint": "",
      "received_at": "2026-10-27T09:29:59Z",
      "rate_rule": "login"
    }
  ],
  "next_cursor": ""
}

#Resumir eventos

GET /v1/orgs/{org}/zones/{zone}/events/summary

Cuenta los eventos que cumplen los filtros (los mismos que Listar eventos) por acción, con las 10 reglas, los 10 países y las 10 reglas de límite de peticiones con más eventos.

Rol necesario: readonly o superior.

#Parámetros

#Respuesta

• 200: Devuelve un objeto con los campos de abajo.

#Errores

#Ejemplo

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d/events/summary" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

import { OpenWAF } from "./openwaf";

const owf = new OpenWAF({ baseUrl: "https://dash.openwaf.dev" }); // token de OPENWAF_TOKEN
const result = await owf.getEventsSummary({
  zone: "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d"
});

from openwaf import OpenWAF

owf = OpenWAF(base_url="https://dash.openwaf.dev")  # token de OPENWAF_TOKEN
result = owf.get_events_summary(zone="6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d")

{
  "since": "2026-10-27T09:30:00Z",
  "until": "2026-10-27T09:30:00Z",
  "total": 128,
  "by_action": [
    {
      "key": "/pricing",
      "count": 128
    }
  ],
  "top_rules": [
    {
      "rule_id": 0,
      "rule_name": "example",
      "count": 128
    }
  ],
  "top_countries": [
    {
      "key": "/pricing",
      "count": 128
    }
  ],
  "top_rate_rules": [
    {
      "key": "/pricing",
      "count": 128
    }
  ]
}

#Histograma de eventos

GET /v1/orgs/{org}/zones/{zone}/events/histogram

Cuenta los eventos que cumplen los filtros por intervalo de tiempo y acción. Las barras de step segundos se alinean a múltiplos de step desde la época Unix, sin huecos (las vacías cuentan 0); la primera contiene since y la última empieza antes de until.

Rol necesario: readonly o superior.

#Parámetros

#Respuesta

• 200: Devuelve EventsHistogram.

#Errores

#Ejemplo

curl "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d/events/histogram" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

import { OpenWAF } from "./openwaf";

const owf = new OpenWAF({ baseUrl: "https://dash.openwaf.dev" }); // token de OPENWAF_TOKEN
const result = await owf.getEventsHistogram({
  zone: "6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d"
});

from openwaf import OpenWAF

owf = OpenWAF(base_url="https://dash.openwaf.dev")  # token de OPENWAF_TOKEN
result = owf.get_events_histogram(zone="6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d")

{
  "since": "2026-10-27T09:30:00Z",
  "until": "2026-10-27T09:30:00Z",
  "step": 0,
  "total": 128,
  "buckets": [
    {
      "ts": "2026-10-27T09:30:00Z",
      "count": 128,
      "block": 0,
      "log": 0,
      "challenge": 0,
      "allow": 0
    }
  ]
}

#Stream de eventos

GET /v1/orgs/{org}/zones/{zone}/events/stream

Emite como Server-Sent Events los eventos de la zona que cumplen los filtros (los mismos que Listar eventos; no se usan since, until ni limit), en el orden en que los recibe OpenWAF. La autenticación, la zona y los filtros se comprueban antes de empezar, así que los errores son respuestas JSON.

El stream empieza tras Last-Event-ID (lo envía EventSource al reconectar) o cursor; sin ellos, 10 segundos antes de la petición. Carga antes GET …/events y descarta los event_id repetidos. Tramas:

• event: ready primero, con {"poll_ms": 2000, "heartbeat_ms": 15000, "max_age_s": 600}.
• event: event por cada evento, con su cursor en id y el evento en data (como en Listar eventos).
• event: ping tras heartbeat_ms sin tráfico, para detectar conexiones colgadas.
• event: bye tras max_age_s, y el stream se cierra; EventSource reconecta con Last-Event-ID sin perder eventos.
• event: error con {"code": "unavailable"} si falla el almacén de eventos, y el stream se cierra.

Un evento recibido más de una hora después de producirse no aparece en el stream (sí en Listar eventos). Como mucho 10 streams por organización.

Rol necesario: readonly o superior.

#Parámetros

#Respuesta

• 200: Stream de Server-Sent Events (tramas descritas arriba). Cuerpo de tipo text/event-stream.

#Errores

#Ejemplo

No está en los SDK: abre el stream con EventSource o con cualquier cliente de Server-Sent Events.

curl -N "https://dash.openwaf.dev/v1/orgs/$OPENWAF_ORG/zones/6f1d2c3b-8a4e-4b7d-9c21-5e3f7a8b9c0d/events/stream?action=block" \
  -H "Authorization: Bearer $OPENWAF_TOKEN"

retry: 3000
event: ready
data: {"poll_ms":2000,"heartbeat_ms":15000,"max_age_s":600}

id: c2V0MTcz…
event: event
data: {"event_id":"…","action":"block","host":"www.example.com","path":"/wp-login.php","client_ip":"203.0.113.10"}