API WireShield Customer API v1.0.30

WireShield Customer API

Read your protection status, attacks, traffic and reports, and manage your own lists, rules and notification settings. Requests are authenticated with an API token created in the customer portal.

Base URL: https://portal.wireshield.network

Getting started

The API is a JSON-over-HTTPS REST API. It is the same API the customer portal uses: you see only your own prefixes, attacks and reports.

  1. Create a token. Sign in to the customer portal, open the user menu (top right) and choose API tokens. Give it a name, optionally make it read-only and restrict it to your source networks, then copy the token. It is shown only once.
  2. Call the API with the token in the Authorization header:
export WS_TOKEN='wsk_…'
curl -H "Authorization: Bearer $WS_TOKEN" https://portal.wireshield.network/v1/whoami
curl -H "Authorization: Bearer $WS_TOKEN" https://portal.wireshield.network/v1/prefixes

Conventions

  • Request and response bodies are JSON (Content-Type: application/json); request bodies are limited to 64 KiB and unknown fields are rejected.
  • Times are RFC 3339 in UTC (2026-10-15T12:00:00Z). Rates are packets per second (pps) and bits per second (bps).
  • Prefixes have a numeric id; attacks (incidents) have an id of the form <prefix_id>-<start_unix>.
  • Resources of other customers do not exist for you: requesting them returns 404.
  • Every change (mode, lists, rules, notification settings) is recorded in the provider's audit log.

Authentication

Send an API token as a Bearer token on every request:

Authorization: Bearer wsk_1a2b3c4d_…

A token acts as the user who created it and has exactly that user's permissions — only your own prefixes and data.

Token options

Lifetime1 hour to 365 days (default 90 days). Expired tokens stop working; create a new one before expiry.
Read-onlyThe token can only read. Any change returns 403. Recommended for dashboards, SIEM pulls and monitoring.
Allowed networksUp to 16 CIDRs. Requests from other source addresses are rejected with 401. The address checked is your client's public address as seen by the portal.

Each user can have at most 20 tokens. The panel shows when each token was last used; revoke tokens you no longer use.

Tokens stop working immediately when they are revoked, when the user is suspended or deleted, or when the user's password is reset. Tokens cannot create other tokens.

Treat a token like a password: store it in a secret manager, never in source code or URLs.

Errors & limits

Errors return a JSON body with an error message. Validation errors (422) also list every problem:

{
  "error": "invalid settings",
  "problems": ["invalid e-mail address: noc@", "choose at least one event"]
}
StatusMeaning
400Malformed request (invalid JSON, unknown field, bad parameter).
401Missing, invalid, expired or revoked token, or a source address outside the token's allowed networks.
403The user lacks the permission, or a read-only token was used for a change.
404Not found — also returned for other customers' resources.
409Conflict with the current state (for example a limit is reached or the resource is in use).
422Validation failed; see problems.
429Rate limited; retry after the number of seconds in Retry-After.
501The feature is not enabled on this deployment.
503Temporarily unavailable (for a change: the audit record could not be written, so nothing was changed).

Rate limits

Each user may send up to 20 requests per second (bursts up to 40), shared by all of the user's tokens; each client address up to 60 per second. Use the live event stream instead of polling quickly for changes.

Live events (SSE)

GET /v1/events is a Server-Sent Events stream. Keep it open to react to attacks within a second instead of polling.

curl -N -H "Authorization: Bearer $WS_TOKEN" https://portal.wireshield.network/v1/events

Each event has a monotonically increasing id, a type and a JSON body:

id: 48211
event: attack.start
data: {"id":48211,"type":"attack.start","time":"2026-10-15T12:00:03Z","prefix_id":7,
       "data":{"time":"2026-10-15T12:00:03Z","event":"attack_start","prefix":"203.0.113.0/24","id":7,
               "vector":"udp_flood","pps":1840000,"bps":7.9e9,"detect_latency_ms":2000,
               "action":"enforce","incident":"7-1792065603","target":"203.0.113.10"}}

Event types

attack.startAn attack was detected. vector, current pps/bps, target (most attacked IP), action (enforce = mitigation on, alert_only = detection only), incident id.
attack.endThe attack ended: duration_s, peak_pps, peak_bps, dropped_packets, final action.
prefix.modeA prefix's protection mode changed (from, to).
mitigation.decidedA mitigation waiting for approval was approved, denied or expired.

You receive only events for your own prefixes.

Reconnecting

  • Reconnect with the last received id in the Last-Event-ID header (or ?last_event_id=); the last 1000 events are replayed.
  • event: reset means events were missed and cannot be replayed: re-read the state (for example GET /v1/incidents).
  • event: overflow closes a consumer that reads too slowly; event: unauthorized ends the stream when the token is revoked or expires.
  • A : ping comment is sent every 15 seconds. At most 5 streams can be open per user.

Python example:

import json, requests
r = requests.get("https://portal.wireshield.network/v1/events", headers={"Authorization": "Bearer " + TOKEN}, stream=True, timeout=(10, 60))
event = None
for line in r.iter_lines(decode_unicode=True):
    if line.startswith("event:"):
        event = line[6:].strip()
    elif line.startswith("data:") and event == "attack.start":
        ev = json.loads(line[5:])
        print("attack on", ev["data"]["prefix"], ev["data"]["vector"])

Authentication

API tokens of the signed-in user. Tokens are created and revoked in the panel (user menu → API tokens).

GET/v1/auth/tokens

My tokens

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of TokenInfo
[
  {
    "cidrs": [
      "203.0.113.0/24"
    ],
    "created": "2026-10-15T12:00:00Z",
    "expires": "2026-10-15T12:00:00Z",
    "id": "string",
    "last_used": "2026-10-15T12:00:00Z",
    "name": "example",
    "read_only": false,
    "user": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/auth/tokens"

GET/v1/whoami

Caller identity

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example Identity
{
  "name": "example",
  "pid": 1,
  "read_only": false,
  "remote": "203.0.113.10",
  "restricted": "string",
  "role": "string",
  "tenant": "acme",
  "uid": 1,
  "via": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/whoami"

Overview & attacks

Dashboard summary and attack (incident) records.

GET/v1/incidents

Attacks (incidents): filter and paginate; sorted by start time descending (tenant: own prefixes only)

permission: incident:read

Parameters

NameInTypeDescription
statusquerystring (active | ended | terminated | closed)active | ended | terminated | closed (ended+terminated)
prefix_idqueryinteger
tenantquerystring
vectorquerystringe.g. udp_flood, syn_flood
fromquerystringstart >= from (RFC3339)
toquerystringstart <= to (RFC3339)
limitqueryintegerpage size (default 50, max 500)
cursorquerystring`next` value from the previous response (opaque)

Responses

200Success
400Invalid parameter/cursor
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Attack records are not configured
Response example IncidentList
{
  "items": [
    {
      "action": "string",
      "approval": null,
      "detect_latency_ms": 0,
      "dropped_packets": 0,
      "duration_s": 0,
      "end": "2026-10-15T12:00:00Z",
      "end_action": "string",
      "id": "string",
      "note_count": 0,
      "peak_bps": 0,
      "peak_pps": 0,
      "prefix": "203.0.113.0/24",
      "prefix_id": 1,
      "resumed": false,
      "start": "2026-10-15T12:00:00Z",
      "start_bps": 0,
      "start_pps": 0,
      "status": "string",
      "tenant": "acme",
      "terminated_by": "string",
      "top_end": null,
      "top_start": null,
      "vector": "udp_flood",
      "vectors": [
        "udp_flood"
      ]
    }
  ],
  "next": "string",
  "total": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/incidents"

GET/v1/incidents/{id}

Attack details: duration, peak values, vectors, start/end summaries (top sources), notes (tenants do not see notes)

permission: incident:read

Parameters

NameInTypeDescription
id requiredpathstring<prefix_id>-<start_unix>

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (for a tenant, another tenant's incident also returns 404)
429Rate limited
501Attack records are not configured
Response example IncidentDetail
{
  "action": "string",
  "approval": {
    "deadline": "2026-10-15T12:00:00Z",
    "decided_at": "2026-10-15T12:00:00Z",
    "decided_by": "string",
    "decision": "string",
    "on_timeout": "string",
    "since": "2026-10-15T12:00:00Z",
    "status": "string",
    "wait_s": 0
  },
  "detect_latency_ms": 0,
  "dropped_packets": 0,
  "duration_s": 0,
  "end": "2026-10-15T12:00:00Z",
  "end_action": "string",
  "id": "string",
  "note_count": 0,
  "notes": [
    {
      "author": "string",
      "text": "string",
      "time": "2026-10-15T12:00:00Z"
    }
  ],
  "peak_bps": 0,
  "peak_pps": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "resumed": false,
  "start": "2026-10-15T12:00:00Z",
  "start_bps": 0,
  "start_pps": 0,
  "status": "string",
  "tenant": "acme",
  "terminated_by": "string",
  "top_end": null,
  "top_start": null,
  "vector": "udp_flood",
  "vectors": [
    "udp_flood"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/incidents/{id}"

GET/v1/incidents/{id}/series

Traffic time series of the attack: 10 s buckets (incoming / dropped pps and bit/s; including 5 min before and after the attack, downsampled for very long attacks), vector (traffic class) composition within the attack window and peak rate/total per countermeasure (drop reason) (estimated from sampling). Used by the PDF attack report and the chart

permission: incident:read

Parameters

NameInTypeDescription
id requiredpathstring<prefix_id>-<start_unix>

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Attack or series record not found (for a tenant, another tenant's incident also returns 404)
429Rate limited
501Attack records or series recording are not configured
Response example Series
{
  "classes": [
    {
      "excess": 0,
      "name": "example",
      "packets": 0
    }
  ],
  "end": "2026-10-15T12:00:00Z",
  "id": "string",
  "partial": false,
  "points": [
    {
      "drop_bps": 0,
      "drop_pps": 0,
      "in_bps": 0,
      "in_pps": 0,
      "t": 0
    }
  ],
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "reasons": [
    {
      "name": "example",
      "packets": 0,
      "peak_pps": 0
    }
  ],
  "start": "2026-10-15T12:00:00Z",
  "step_s": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/incidents/{id}/series"

GET/v1/overview

Overview: rates, totals, active/recent attacks, most attacked destinations, system health, feature flags (tenant: own prefixes only)

permission: prefix:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example Overview
{
  "active_incidents": [
    {
      "action": "string",
      "approval": null,
      "detect_latency_ms": 0,
      "dropped_packets": 0,
      "duration_s": 0,
      "end": "2026-10-15T12:00:00Z",
      "end_action": "string",
      "id": "string",
      "note_count": 0,
      "peak_bps": 0,
      "peak_pps": 0,
      "prefix": "203.0.113.0/24",
      "prefix_id": 1,
      "resumed": false,
      "start": "2026-10-15T12:00:00Z",
      "start_bps": 0,
      "start_pps": 0,
      "status": "string",
      "tenant": "acme",
      "terminated_by": "string",
      "top_end": null,
      "top_start": null,
      "vector": "udp_flood",
      "vectors": [
        "udp_flood"
      ]
    }
  ],
  "capabilities": {
    "bgp": false,
    "flowspec": false,
    "gre": false,
    "incident_notes": false,
    "incident_terminate": false,
    "incidents": false,
    "interfaces": false,
    "license": false,
    "notifications": false,
    "pcap": false,
    "protection_editor": false,
    "reports_pdf": false,
    "rtbh": false,
    "sampling": false,
    "telemetry": false,
    "tenants": false,
    "threat_intel": false,
    "updates": false,
    "usage_billing": false,
    "users": false
  },
  "health": {
    "cpu_avg_pct": 0,
    "cpu_max_pct": 0,
    "disk_free_pct": 0,
    "hostname": "string",
    "issues": [
      "string"
    ],
    "load1": 0,
    "mem_used_pct": 0,
    "status": "string",
    "uptime_s": 0,
    "version": "string"
  },
  "prefixes": {
    "bypass": 0,
    "enforce": 0,
    "sensor": 0,
    "total": 0
  },
  "rates": {
    "clean_bps": 0,
    "drop_bps": 0,
    "drop_pps": 0,
    "rx_bps": 0,
    "rx_pps": 0,
    "wd_bps": 0,
    "window_secs": 0
  },
  "recent_incidents": [
    {
      "action": "string",
      "approval": null,
      "detect_latency_ms": 0,
      "dropped_packets": 0,
      "duration_s": 0,
      "end": "2026-10-15T12:00:00Z",
      "end_action": "string",
      "id": "string",
      "note_count": 0,
      "peak_bps": 0,
      "peak_pps": 0,
      "prefix": "203.0.113.0/24",
      "prefix_id": 1,
      "resumed": false,
      "start": "2026-10-15T12:00:00Z",
      "start_bps": 0,
      "start_pps": 0,
      "status": "string",
      "tenant": "acme",
      "terminated_by": "string",
      "top_end": null,
      "top_start": null,
      "vector": "udp_flood",
      "vectors": [
        "udp_flood"
      ]
    }
  ],
  "sample_rate": 0,
  "scope": "string",
  "tenant": "acme",
  "time": "2026-10-15T12:00:00Z",
  "top_prefixes": [
    {
      "cc": "string",
      "est_pps": 0,
      "key": "string",
      "max_err_pps": 0,
      "share": 0
    }
  ],
  "top_targets": [
    {
      "cc": "string",
      "est_pps": 0,
      "key": "string",
      "max_err_pps": 0,
      "share": 0
    }
  ],
  "totals": {
    "bytes": 0,
    "drop_bytes": 0,
    "drop_packets": 0,
    "packets": 0,
    "wd_packets": 0
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/overview"

GET/v1/prefixes/{id}/hosts

Destination IPs within the prefix: exact counters + (if available) estimated rate/share from sampling (Traffic Analyzer)

permission: prefix:read

Parameters

NameInTypeDescription
id requiredpathinteger
nqueryintegermaximum records (default 20, max 1000)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found (for a tenant, another tenant's prefix also returns 404)
429Rate limited
Response example array of HostRow
[
  {
    "addr": "203.0.113.10",
    "est_pps": 0,
    "est_share": 0,
    "stats": {
      "bytes": 0,
      "drop_bytes": 0,
      "drop_packets": 0,
      "packets": 0,
      "wd_bytes": 0,
      "wd_packets": 0
    }
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/hosts"

Prefixes & attacks

Protected prefixes, their protection mode, live attack state and counters.

GET/v1/attacks

Attack events (tenant: own prefixes only)

permission: attack:read

Parameters

NameInTypeDescription
nqueryinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of AttackRecord
[
  {
    "action": "string",
    "bps": 0,
    "by": "string",
    "deadline": "2026-10-15T12:00:00Z",
    "decision": "string",
    "detect_latency_ms": 0,
    "dropped_packets": 0,
    "duration_s": 0,
    "event": "attack.start",
    "id": 1,
    "incident": "string",
    "on_timeout": "string",
    "peak_bps": 0,
    "peak_pps": 0,
    "pps": 0,
    "prefix": "203.0.113.0/24",
    "resumed": false,
    "target": "203.0.113.10",
    "time": "2026-10-15T12:00:00Z",
    "top": null,
    "vector": "udp_flood",
    "vectors": [
      "udp_flood"
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/attacks"

GET/v1/classes

Per-prefix traffic class counters

permission: prefix:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of ClassView
[
  {
    "classes": [
      {
        "name": "example",
        "stats": null
      }
    ],
    "id": 1,
    "prefix": "203.0.113.0/24"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/classes"

GET/v1/hosts

Top destinations by traffic (tenant: own prefixes only)

permission: prefix:read

Parameters

NameInTypeDescription
nqueryinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of HostInfo
[
  {
    "addr": "203.0.113.10",
    "stats": {
      "bytes": 0,
      "drop_bytes": 0,
      "drop_packets": 0,
      "packets": 0,
      "wd_bytes": 0,
      "wd_packets": 0
    }
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/hosts"

GET/v1/prefixes

Protected prefixes (tenant: own only)

permission: prefix:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of PrefixView
[
  {
    "configured_mode": "string",
    "description": "string",
    "group": 0,
    "id": 1,
    "mode": 0,
    "mode_name": "string",
    "prefix": "203.0.113.0/24",
    "profile": 0,
    "stats": {
      "bytes": 0,
      "drop_bytes": 0,
      "drop_packets": 0,
      "packets": 0,
      "wd_bytes": 0,
      "wd_packets": 0
    },
    "tenant": "acme"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes"

PUT/v1/prefixes/{id}/mode

Change the prefix mode (temporary). Tenant: own prefix only, if the tenant policy allows it, sensor/enforce only

permission: mode:setaudited

Parameters

NameInTypeDescription
id requiredpathinteger

Request body ModeRequest

FieldType
mode requiredstring
reasonstring
{
  "mode": "enforce",
  "reason": "string"
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
503Audit record could not be written (operation not performed)
Response example ModeResponse
{
  "id": 1,
  "mode": "enforce",
  "prefix": "203.0.113.0/24"
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"mode":"enforce","reason":"string"}' \
  "https://portal.wireshield.network/v1/prefixes/{id}/mode"

Traffic

Sampled traffic: time series, top talkers and host statistics.

GET/v1/prefixes/{id}/series

Prefix time series (pps/bps: rx, clean, dropped, would-drop)

permission: prefix:read

Parameters

NameInTypeDescription
id requiredpathinteger
resquerystring (1s | 10s | 1m | 1h)1s (global and prefixes under attack only) | 10s (default) | 1m, 1h (disk series; missing point = 0)
fromquerystringRFC3339; default: 15 min ago for 1s, 1 h for 10s, 6 h for 1m, 7 days for 1h
toquerystringRFC3339; default: now. Maximum range: 1s/10s 24 hours, 1m 7 days, 1h 400 days

Responses

200Success
400Invalid parameter
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found (for a tenant, another tenant's prefix also returns 404)
4091 s resolution is not kept for this prefix (not under attack)
429Rate limited
501Telemetry or (for 1m/1h) disk series is not configured
Response example SeriesResponse
{
  "from": "2026-10-15T12:00:00Z",
  "points": [
    {
      "clean_bps": 0,
      "drop_bps": 0,
      "drop_pps": 0,
      "rx_bps": 0,
      "rx_pps": 0,
      "t": 0,
      "wd_bps": 0
    }
  ],
  "prefix_id": 1,
  "res": "string",
  "to": "2026-10-15T12:00:00Z"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/series"

GET/v1/prefixes/{id}/top

Sample-based summary: top sources, /24-/48, destinations, ports, protocols, distinct source estimate (ESTIMATED)

permission: prefix:read

Parameters

NameInTypeDescription
id requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found (for a tenant, another tenant's prefix also returns 404)
429Rate limited
501Telemetry is not configured
Response example TopResponse
{
  "available": false,
  "sample_rate": 0,
  "snapshot": {
    "asns": [],
    "classes": [],
    "complete": false,
    "countries": [],
    "distinct_sources_est": 0,
    "dst_ports": [],
    "est_bps": 0,
    "est_pps": 0,
    "estimated": false,
    "prefix_id": 1,
    "prefixes": [],
    "protocols": [],
    "reasons": [],
    "samples": 0,
    "sizes": [],
    "source_nets": [],
    "sources": [],
    "src_ports": [],
    "targets": [],
    "tcp_flags": [],
    "verdicts": [],
    "window_secs": 0,
    "window_start": "2026-10-15T12:00:00Z"
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/top"

Forensics

Packet samples and flows recorded during attacks; packet captures (PCAP).

GET/v1/incidents/{id}/flows

Flow summary of the attack archive: 5-tuple + weighted (estimated) packets/bytes per verdict, top N by packet count descending. distinct_sources is the number of unique sources; truncated indicates new keys were not counted because of too many distinct flows

permission: incident:read

Parameters

NameInTypeDescription
id requiredpathstring<prefix_id>-<start_unix>
srcquerystringsource IP or CIDR (sources may be spoofed)
dstquerystringdestination IP or CIDR
sportqueryintegersource port
dportqueryintegerdestination port
protoquerystringtcp | udp | icmp | icmpv6 | gre | esp | sctp or 0-255
verdictquerystringpass | drop | would_drop | challenge
reasonquerystringdrop reason (e.g. rate, rule, blocklist)
nqueryintegermaximum flows (default 50, max 1000)

Responses

200Success
400Invalid filter/parameter
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Attack or its archive not found (for a tenant, another tenant's attack also returns 404)
429Rate limited
501Attack records or the sample archive are disabled
Response example ArchiveFlows
{
  "archive": {
    "closed": false,
    "dropped": 0,
    "end": "2026-10-15T12:00:00Z",
    "id": "string",
    "merged": 0,
    "partial": false,
    "prefix": "203.0.113.0/24",
    "prefix_id": 1,
    "records": 0,
    "start": "2026-10-15T12:00:00Z",
    "truncated": false
  },
  "summary": {
    "bytes_est": 0,
    "distinct_sources": 0,
    "flows": [
      {
        "bytes_est": null,
        "dport": null,
        "dst": null,
        "first_ms": null,
        "last_ms": null,
        "packets_est": null,
        "proto": null,
        "samples": null,
        "sport": null,
        "src": null,
        "verdict": null
      }
    ],
    "packets_est": 0,
    "total_flows": 0,
    "truncated": false
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/incidents/{id}/flows"

GET/v1/incidents/{id}/samples

Raw sample archive of the attack: packet headers sampled by XDP (from 60 s before the attack to 60 s after; no payload). Each record is one sampled packet (w = number of packets it represents); samples above 2000 records per second are merged by weight (n = number of merged samples). During an active attack the archive is read with ~1 s delay (archive.closed=false); it is closed and compressed 60 s after the attack ends

permission: incident:read

Parameters

NameInTypeDescription
id requiredpathstring<prefix_id>-<start_unix>
srcquerystringsource IP or CIDR (sources may be spoofed)
dstquerystringdestination IP or CIDR
sportqueryintegersource port
dportqueryintegerdestination port
protoquerystringtcp | udp | icmp | icmpv6 | gre | esp | sctp or 0-255
verdictquerystringpass | drop | would_drop | challenge
reasonquerystringdrop reason (e.g. rate, rule, blocklist)
limitqueryintegerpage size (default 100, max 1000)
offsetqueryinteger`next_offset` from the previous response

Responses

200Success
400Invalid filter/parameter
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Attack or its archive not found (for a tenant, another tenant's attack also returns 404)
429Rate limited
501Attack records or the sample archive are disabled
Response example ArchiveSamples
{
  "archive": {
    "closed": false,
    "dropped": 0,
    "end": "2026-10-15T12:00:00Z",
    "id": "string",
    "merged": 0,
    "partial": false,
    "prefix": "203.0.113.0/24",
    "prefix_id": 1,
    "records": 0,
    "start": "2026-10-15T12:00:00Z",
    "truncated": false
  },
  "next_offset": 0,
  "samples": [
    {
      "c": "string",
      "dp": 0,
      "dst": "203.0.113.10",
      "flags": 0,
      "len": 0,
      "n": 0,
      "proto": 0,
      "r": "string",
      "sp": 0,
      "src": "203.0.113.10",
      "t": 0,
      "ttl": 0,
      "v": "string",
      "w": 0
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/incidents/{id}/samples"

Live events

Server-Sent Events stream for attack and state changes.

GET/v1/events

Live event stream (Server-Sent Events). Events: attack.start, attack.end, prefix.mode, protection.changed, incident.note. Each event's id is monotonic and stays greater than previous ones across restarts; with Last-Event-ID (header or last_event_id) the last 1000 events are replayed, and if the events in between are no longer kept, event: reset is sent (re-read the state). A slow consumer is closed with event: overflow. A : ping every 15 s; the stream ends with event: unauthorized if the session/account/token becomes invalid. A tenant sees only attack/mode events for its own prefixes (no protection or note events). Events are notifications only: the source of truth is the event file and the state stores.

permission: prefix:readtext/event-stream

Parameters

NameInTypeDescription
last_event_idqueryintegerequivalent to the Last-Event-ID header

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Event stream is not configured
503Too many subscribers (200 total, 5 per identity)
curl -N -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/events"

Customer account

The customer's protection summary and its own e-mail notification settings.

GET/v1/my/notifications

The customer's notification channels (target masked: scheme+host only) and recent deliveries (error details are not provided)

permission: prefix:read

Responses

200Success
400The tenant parameter is required for staff
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Customer not found
429Rate limited
Response example MyNotifications
{
  "channels": [
    {
      "enabled": false,
      "id": "string",
      "name": "example",
      "self": false,
      "target": "203.0.113.10",
      "type": "attack.start"
    }
  ],
  "history": [
    {
      "channel": "string",
      "result": "string",
      "time": "2026-10-15T12:00:00Z",
      "title": "example",
      "type": "attack.start"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/my/notifications"

GET/v1/my/notifications/settings

The customer's own e-mail notification settings: recipients, selected events (attack started/ended, report ready, prefix mode changed) and language. available=false when the provider has not offered an e-mail channel to customers. SMTP settings are never shown

permission: prefix:read

Responses

200Success
400The tenant parameter is required for staff
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Customer not found
429Rate limited
501Notifications are not configured
Response example MyNotifySettings
{
  "available": false,
  "enabled": false,
  "event_types": [
    "attack.start"
  ],
  "events": [
    "attack.start"
  ],
  "language": "en",
  "recipients": [
    "noc@example.com"
  ],
  "sender": "noc@example.com"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/my/notifications/settings"

PUT/v1/my/notifications/settings

Saves the customer's own e-mail notification settings (at most 10 recipients; only customer events can be selected; system/operator events are never sent to customers). Mail is sent through the e-mail channel the provider marked as open to customers; no recipients = the customer's channel and rule are removed. Audited (addresses are not written to the audit log)

permission: mynotify:writeaudited

Request body MyNotifyInput

FieldType
enabled requiredboolean
events requiredarray of string
language requiredstring
recipients requiredarray of string
{
  "enabled": false,
  "events": [
    "attack.start"
  ],
  "language": "en",
  "recipients": [
    "noc@example.com"
  ]
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Customer not found
409The provider has not offered e-mail notifications
422Invalid settings
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example MyNotifySettings
{
  "available": false,
  "enabled": false,
  "event_types": [
    "attack.start"
  ],
  "events": [
    "attack.start"
  ],
  "language": "en",
  "recipients": [
    "noc@example.com"
  ],
  "sender": "noc@example.com"
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"enabled":false,"events":["attack.start"],"language":"en","recipients":["noc@example.com"]}' \
  "https://portal.wireshield.network/v1/my/notifications/settings"

POST/v1/my/notifications/test

Sends a test e-mail to the customer's recipients (once a minute per customer). Error details are not returned to the customer; staff see them in the delivery history

permission: mynotify:writeaudited

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409No enabled settings saved yet
429Wait a minute between tests
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example MyNotifyTestResult
{
  "ok": false
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/my/notifications/test"

GET/v1/my/protection

READ-ONLY, threshold-free summary of the protection applied to the customer's own prefixes: prefixes and operating mode, groups, protection features (SYN authentication, amplification filter, etc.), rules (name, action, readable match summary, packet/drop counts) and the rate limits in use. Detection thresholds and other customers' information are NOT included

permission: prefix:read

Responses

200Success
400The tenant parameter is required for staff
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Customer not found (another customer's also returns 404)
429Rate limited
501No protection configuration
Response example MyProtection
{
  "groups": [
    {
      "id": 1,
      "prefixes": []
    }
  ],
  "limiters": [
    {
      "bps": 0,
      "name": "example",
      "pps": 0,
      "scope": "string"
    }
  ],
  "name": "example",
  "plan": "string",
  "prefixes": [
    {
      "cidr": "203.0.113.0/24",
      "configured": "string",
      "description": "string",
      "group": 0,
      "id": 1,
      "mode": "enforce",
      "profile": 0
    }
  ],
  "profiles": [
    {
      "features": [
        "string"
      ],
      "id": 1,
      "name": "example",
      "proto_allow": [
        "string"
      ],
      "rules": []
    }
  ],
  "quota_bps": 0,
  "tenant": "acme"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/my/protection"

Baseline learning

Learned normal-traffic baselines used for detection.

GET/v1/prefixes/{id}/learning

Learning/monitor mode: while the prefix is in mode: learning no packets are dropped; detection and policies run but no action is applied ('would have' records appear in the attack list with action=learning). This endpoint returns the per-class pps/bit-s distribution (p50/p95/p99/peak) learned from NON-ATTACK (normal) traffic, the current static threshold in the profile and the suggested threshold (suggestion = max(p99×2, peak×1.25), floor 1000 pps / 10 Mbit/s, rounded up to two significant digits). ready becomes true after at least 6 hours of normal traffic are observed. The suggestion is informational: it is applied to the profile manually (with preview); suggested_thresholds_json is in the profile's detection.thresholds format

permission: prefix:read

Parameters

NameInTypeDescription
id requiredpathintegerprefix ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found (for a tenant, another tenant's prefix also returns 404)
429Rate limited
501Learning data is disabled
Response example LearningView
{
  "learning": false,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "report": {
    "attack_s": 0,
    "classes": [],
    "last_seen": "2026-10-15T12:00:00Z",
    "min_observed_s": 0,
    "observed_s": 0,
    "prefix_id": 1,
    "ready": false,
    "since": "2026-10-15T12:00:00Z",
    "suggested_thresholds_json": "string",
    "would_actions": []
  },
  "tenant": "acme"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/learning"

POST/v1/prefixes/{id}/learning/reset

Delete the learned distribution (new learning period). Permission: mode change (management roles; a tenant only for its own prefix and if allowed)

permission: mode:setaudited

Parameters

NameInTypeDescription
id requiredpathintegerprefix ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found (for a tenant, another tenant's prefix also returns 404)
429Rate limited
501Learning data is disabled
503Audit record could not be written (operation not performed)
Response example map of any
{
  "key": null
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/learning/reset"

Allow & deny lists

Per-prefix source allow/deny lists.

GET/v1/prefixes/{id}/lists

The prefix's customer allow/deny lists. A tenant sees ONLY its own prefix (another tenant's returns 404); the username of the user who added an entry is not shown to the tenant. limit: per-list quota for this identity, can_edit: write permission

permission: prefixlist:read

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found or not visible
429Rate limited
501Managed state store is disabled
Response example PrefixListView
{
  "allow": [
    {
      "added": "2026-10-15T12:00:00Z",
      "by": "string",
      "cidr": "203.0.113.0/24",
      "comment": "string",
      "kind": "string",
      "prefix": 0
    }
  ],
  "can_edit": false,
  "deny": [
    {
      "added": "2026-10-15T12:00:00Z",
      "by": "string",
      "cidr": "203.0.113.0/24",
      "comment": "string",
      "kind": "string",
      "prefix": 0
    }
  ],
  "limit": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "tenant": "acme"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/lists"

POST/v1/prefixes/{id}/lists/{kind}

Add an entry to the list (single IP or CIDR; v4 ≥ /8, v6 ≥ /32; loopback/multicast/link-local/reserved ranges are rejected). Order: global allow > global deny > prefix allow > prefix deny > …; a customer allow bypasses all remaining filters but cannot override the operator's global deny. A tenant needs the can_edit_lists policy and the list_limit quota

permission: prefixlist:writeaudited

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID
kind requiredpathstring (allow | deny)allow | deny

Request body PrefixListAdd

FieldType
cidr requiredstring
commentstring
{
  "cidr": "203.0.113.0/24",
  "comment": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found or not visible
409Duplicate entry, or the same network is in the opposite list
422Invalid CIDR/quota exceeded
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example PrefixListEntry
{
  "added": "2026-10-15T12:00:00Z",
  "by": "string",
  "cidr": "203.0.113.0/24",
  "comment": "string",
  "kind": "string",
  "prefix": 0
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"cidr":"203.0.113.0/24","comment":"string"}' \
  "https://portal.wireshield.network/v1/prefixes/{id}/lists/{kind}"

DELETE/v1/prefixes/{id}/lists/{kind}

Delete an entry from the list (with ?cidr=)

permission: prefixlist:writeaudited

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID
kind requiredpathstring (allow | deny)allow | deny
cidrquerystringentry to delete

Responses

200Success
400cidr is missing
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix or entry not found
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example map of string
{
  "key": "string"
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/lists/{kind}"

Custom rules

Per-prefix custom filtering rules.

GET/v1/prefixes/{id}/rules

The prefix's custom rules (in priority order) and their counters. A tenant sees only its own prefix; the username of the rule author is not shown to the tenant

permission: prefixlist:read

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found or not visible
429Rate limited
501Managed state store is disabled
Response example CustomRulesView
{
  "can_edit": false,
  "configured_mode": "string",
  "limit": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "rules": [
    {
      "action": "string",
      "active": false,
      "added": "2026-10-15T12:00:00Z",
      "bps": 0,
      "by": "string",
      "disabled": false,
      "expires": "2026-10-15T12:00:00Z",
      "id": 1,
      "match": {
        "any": null,
        "asn": null,
        "country": null,
        "dst_port": null,
        "fragment": null,
        "icmp_code": null,
        "icmp_type": null,
        "length": null,
        "payload": null,
        "proto": null,
        "src_port": null,
        "tcp_flags": null,
        "ttl": null
      },
      "name": "example",
      "pps": 0,
      "prefix": 0,
      "priority": 0,
      "scope": "string",
      "source": "string",
      "stats": {
        "bytes": null,
        "drop_bytes": null,
        "drop_packets": null,
        "packets": null,
        "wd_bytes": null,
        "wd_packets": null
      },
      "updated": "2026-10-15T12:00:00Z",
      "when": "string"
    }
  ],
  "tenant": "acme"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/rules"

POST/v1/prefixes/{id}/rules

Add a custom rule. Order: global allow/deny > customer allow/deny lists > malformed packets > custom rules (by priority, first match wins) > profile. when=always: an Automatic prefix applies it even when there is no attack; attack: only while filters are engaged. In Monitor/Learning no rule drops (counted as wd); in Bypass rules are not evaluated. action=limit is the rule's own limit (pps/bps, scope prefix|dst|src). A tenant needs can_edit_rules and rule_limit; a tenant's allow rule requires a specific source (v4 ≥ /16, v6 ≥ /48)

permission: prefixlist:writeaudited

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID

Request body CustomRuleRequest

FieldType
action requiredstring
bpsnumber
disabledboolean
expiresstring (date-time) | null
match requiredConfigMatch
namestring
ppsnumber
priority requiredinteger (int64)
scopestring
sourcestring
when requiredstring
{
  "action": "string",
  "bps": 0,
  "disabled": false,
  "expires": "2026-10-15T12:00:00Z",
  "match": {
    "any": false,
    "asn": 0,
    "country": "string",
    "dst_port": "string",
    "fragment": "string",
    "icmp_code": 0,
    "icmp_type": 0,
    "length": "string",
    "payload": {
      "ascii": null,
      "hex": null,
      "mask": null,
      "offset": null,
      "template": null
    },
    "proto": "string",
    "src_port": "string",
    "tcp_flags": "string",
    "ttl": "string"
  },
  "name": "example",
  "pps": 0,
  "priority": 0,
  "scope": "string",
  "source": "string",
  "when": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix or rule not found / not visible
422Invalid rule or quota exceeded
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example CustomRuleView
{
  "action": "string",
  "active": false,
  "added": "2026-10-15T12:00:00Z",
  "bps": 0,
  "by": "string",
  "disabled": false,
  "expires": "2026-10-15T12:00:00Z",
  "id": 1,
  "match": {
    "any": false,
    "asn": 0,
    "country": "string",
    "dst_port": "string",
    "fragment": "string",
    "icmp_code": 0,
    "icmp_type": 0,
    "length": "string",
    "payload": {
      "ascii": null,
      "hex": null,
      "mask": null,
      "offset": null,
      "template": null
    },
    "proto": "string",
    "src_port": "string",
    "tcp_flags": "string",
    "ttl": "string"
  },
  "name": "example",
  "pps": 0,
  "prefix": 0,
  "priority": 0,
  "scope": "string",
  "source": "string",
  "stats": {
    "bytes": 0,
    "drop_bytes": 0,
    "drop_packets": 0,
    "packets": 0,
    "wd_bytes": 0,
    "wd_packets": 0
  },
  "updated": "2026-10-15T12:00:00Z",
  "when": "string"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"action":"string","bps":0,"disabled":false,"expires":"2026-10-15T12:00:00Z","match":{"any":false,"asn":0,"country":"string","dst_port":"string","fragment":"string","icmp_code":0,"icmp_type":0,"length":"string","payload":{"ascii":null,"hex":null,"mask":null,"offset":null,"template":null},"proto":"string","src_port":"string","tcp_flags":"string","ttl":"string"},"name":"example","pps":0,"priority":0,"scope":"string","source":"string","when":"string"}' \
  "https://portal.wireshield.network/v1/prefixes/{id}/rules"

PUT/v1/prefixes/{id}/rules/{rid}

Replace a custom rule (all fields; ID and creation time are kept). Counters are reset when the content changes, and kept when only the priority changes

permission: prefixlist:writeaudited

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID
rid requiredpathintegercustom rule ID

Request body CustomRuleRequest

FieldType
action requiredstring
bpsnumber
disabledboolean
expiresstring (date-time) | null
match requiredConfigMatch
namestring
ppsnumber
priority requiredinteger (int64)
scopestring
sourcestring
when requiredstring
{
  "action": "string",
  "bps": 0,
  "disabled": false,
  "expires": "2026-10-15T12:00:00Z",
  "match": {
    "any": false,
    "asn": 0,
    "country": "string",
    "dst_port": "string",
    "fragment": "string",
    "icmp_code": 0,
    "icmp_type": 0,
    "length": "string",
    "payload": {
      "ascii": null,
      "hex": null,
      "mask": null,
      "offset": null,
      "template": null
    },
    "proto": "string",
    "src_port": "string",
    "tcp_flags": "string",
    "ttl": "string"
  },
  "name": "example",
  "pps": 0,
  "priority": 0,
  "scope": "string",
  "source": "string",
  "when": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix or rule not found / not visible
422Invalid rule or quota exceeded
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example CustomRuleView
{
  "action": "string",
  "active": false,
  "added": "2026-10-15T12:00:00Z",
  "bps": 0,
  "by": "string",
  "disabled": false,
  "expires": "2026-10-15T12:00:00Z",
  "id": 1,
  "match": {
    "any": false,
    "asn": 0,
    "country": "string",
    "dst_port": "string",
    "fragment": "string",
    "icmp_code": 0,
    "icmp_type": 0,
    "length": "string",
    "payload": {
      "ascii": null,
      "hex": null,
      "mask": null,
      "offset": null,
      "template": null
    },
    "proto": "string",
    "src_port": "string",
    "tcp_flags": "string",
    "ttl": "string"
  },
  "name": "example",
  "pps": 0,
  "prefix": 0,
  "priority": 0,
  "scope": "string",
  "source": "string",
  "stats": {
    "bytes": 0,
    "drop_bytes": 0,
    "drop_packets": 0,
    "packets": 0,
    "wd_bytes": 0,
    "wd_packets": 0
  },
  "updated": "2026-10-15T12:00:00Z",
  "when": "string"
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"action":"string","bps":0,"disabled":false,"expires":"2026-10-15T12:00:00Z","match":{"any":false,"asn":0,"country":"string","dst_port":"string","fragment":"string","icmp_code":0,"icmp_type":0,"length":"string","payload":{"ascii":null,"hex":null,"mask":null,"offset":null,"template":null},"proto":"string","src_port":"string","tcp_flags":"string","ttl":"string"},"name":"example","pps":0,"priority":0,"scope":"string","source":"string","when":"string"}' \
  "https://portal.wireshield.network/v1/prefixes/{id}/rules/{rid}"

DELETE/v1/prefixes/{id}/rules/{rid}

Delete a custom rule

permission: prefixlist:writeaudited

Parameters

NameInTypeDescription
id requiredpathintegerprotected prefix ID
rid requiredpathintegercustom rule ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix or rule not found
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example map of integer (int32)
{
  "key": 0
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/prefixes/{id}/rules/{rid}"

Upstream mitigation

RTBH / FlowSpec announcements to upstream routers.

GET/v1/escalations

Upstream entries (RTBH and FlowSpec): target, match, duration, remaining time, whether it is announced to the routers, announcement error. Source: manual (API/CLI), customer (the customer's BGP community; in memory only, removed when the customer withdraws), policy (suggestion awaiting approval). A tenant sees only its own entries

permission: escalation:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
Response example array of EscalationView
[
  {
    "action": "string",
    "advertised": false,
    "created": "2026-10-15T12:00:00Z",
    "created_by": "string",
    "dst_ports": "string",
    "error": "string",
    "expired": false,
    "expires": "2026-10-15T12:00:00Z",
    "id": 1,
    "kind": "string",
    "length": "string",
    "prefix": "203.0.113.0/24",
    "proto": "string",
    "rate_bps": 0,
    "reason": "string",
    "remaining_s": 0,
    "source": "string",
    "src_ports": "string",
    "src_prefix": "string",
    "status": "string",
    "tenant": "acme"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/escalations"

GET/v1/escalations/{id}

Single entry

permission: escalation:read

Parameters

NameInTypeDescription
id requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Entry not found (another tenant's entry also returns 404)
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
Response example EscalationView
{
  "action": "string",
  "advertised": false,
  "created": "2026-10-15T12:00:00Z",
  "created_by": "string",
  "dst_ports": "string",
  "error": "string",
  "expired": false,
  "expires": "2026-10-15T12:00:00Z",
  "id": 1,
  "kind": "string",
  "length": "string",
  "prefix": "203.0.113.0/24",
  "proto": "string",
  "rate_bps": 0,
  "reason": "string",
  "remaining_s": 0,
  "source": "string",
  "src_ports": "string",
  "src_prefix": "string",
  "status": "string",
  "tenant": "acme"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/escalations/{id}"

GRE tunnels

GRE tunnels used to return clean traffic.

GET/v1/tunnel-status

Tunnel system summary: number of tunnels, present in the kernel, operationally up, with errors; if ip_forward is off, clean traffic does not enter the tunnels; clamp_error if the MSS clamping rules could not be applied

permission: tunnel:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Tunnels are not configured
Response example TunnelSystem
{
  "clamp_error": "string",
  "errors": 0,
  "ip_forward": false,
  "oper_up": 0,
  "present": 0,
  "tunnels": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tunnel-status"

GET/v1/tunnels

Customer GRE tunnels and their live state in the kernel (whether the interface exists, admin/oper state, MTU, addresses, counters, last reconcile error) with a health summary (live.health: ICMP probe to the inner peer address + BGP session → ok | degraded | down | unknown | disabled, rtt, loss, counters). A tenant sees only its own tunnels

permission: tunnel:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Tunnels are not configured
Response example array of TunnelView
[
  {
    "bgp": {
      "as_set": "string",
      "asn": 0,
      "disabled": false,
      "group": 0,
      "irr": "string",
      "max_len_v4": 0,
      "max_len_v6": 0,
      "max_prefixes": 0,
      "mode": "enforce",
      "profile": 0,
      "rpki": "string"
    },
    "comment": "string",
    "disabled": false,
    "id": 1,
    "inner_local": "string",
    "inner_peer": "string",
    "key": 0,
    "live": {
      "addrs": [
        "203.0.113.10"
      ],
      "error": "string",
      "health": null,
      "ifname": "string",
      "last_action": "string",
      "mtu": 0,
      "oper_up": false,
      "present": false,
      "rx_bytes": 0,
      "rx_dropped": 0,
      "rx_errors": 0,
      "rx_packets": 0,
      "tx_bytes": 0,
      "tx_dropped": 0,
      "tx_errors": 0,
      "tx_packets": 0,
      "up": false
    },
    "local": "string",
    "mss_clamp": false,
    "mtu": 0,
    "name": "example",
    "no_probe": false,
    "remote": "203.0.113.10",
    "routes": [
      "string"
    ],
    "tenant": "acme",
    "ttl": 0
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tunnels"

GET/v1/tunnels/{id}

Single tunnel

permission: tunnel:read

Parameters

NameInTypeDescription
id requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Tunnel not found (another tenant's tunnel also returns 404)
429Rate limited
501Tunnels are not configured
Response example TunnelView
{
  "bgp": {
    "as_set": "string",
    "asn": 0,
    "disabled": false,
    "group": 0,
    "irr": "string",
    "max_len_v4": 0,
    "max_len_v6": 0,
    "max_prefixes": 0,
    "mode": "enforce",
    "profile": 0,
    "rpki": "string"
  },
  "comment": "string",
  "disabled": false,
  "id": 1,
  "inner_local": "string",
  "inner_peer": "string",
  "key": 0,
  "live": {
    "addrs": [
      "203.0.113.10"
    ],
    "error": "string",
    "health": {
      "bgp": null,
      "error": null,
      "failures": null,
      "last_ok": null,
      "last_rtt_ms": null,
      "loss_pct": null,
      "overall": null,
      "probe": null,
      "probes": null,
      "reason": null,
      "rtt_ms": null,
      "since": null
    },
    "ifname": "string",
    "last_action": "string",
    "mtu": 0,
    "oper_up": false,
    "present": false,
    "rx_bytes": 0,
    "rx_dropped": 0,
    "rx_errors": 0,
    "rx_packets": 0,
    "tx_bytes": 0,
    "tx_dropped": 0,
    "tx_errors": 0,
    "tx_packets": 0,
    "up": false
  },
  "local": "string",
  "mss_clamp": false,
  "mtu": 0,
  "name": "example",
  "no_probe": false,
  "remote": "203.0.113.10",
  "routes": [
    "string"
  ],
  "tenant": "acme",
  "ttl": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tunnels/{id}"

BGP

BGP sessions and announced prefixes.

GET/v1/bgp/prefixes

Every announcement received from customers and its decision: active (being announced to the router), pending (accepted, waiting for data plane/route), rejected (reason stable code: not-authorized, too-long, bogon, as-loop, first-as, origin-as, origin-set, recursive, rpki-invalid, rpki-notfound, irr-no-route, superseded, tenant-quota, no-next-hop ...). Warnings for accepted ones (warnings) and the RPKI/IRR result are shown

permission: bgp:read

Parameters

NameInTypeDescription
statusquerystring
tunnelqueryinteger
prefixquerystring

Responses

200Success
400Invalid filter
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501BGP is not enabled on this appliance
Response example array of BGPPrefixView
[
  {
    "accepted": false,
    "advertised": false,
    "as_path": [
      0
    ],
    "error": "string",
    "irr": "string",
    "origin": 0,
    "peer": "203.0.113.10",
    "prefix": "203.0.113.0/24",
    "reason": "string",
    "routed": false,
    "rpki": "string",
    "since": "2026-10-15T12:00:00Z",
    "status": "string",
    "tenant": "acme",
    "tunnel": 0,
    "warnings": [
      "string"
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/bgp/prefixes"

GET/v1/bgp/sessions

BGP sessions: customer sessions (per tunnel, peer AS, state, received/accepted prefixes) and router sessions (staff only). A tenant sees only its own customer sessions. md5 and gtsm indicate the session is protected with TCP-MD5 / GTSM; the password itself never appears in any response

permission: bgp:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501BGP is not enabled on this appliance
Response example array of BGPSessionView
[
  {
    "accepted": 0,
    "asn": 0,
    "error": "string",
    "gtsm": false,
    "kind": "string",
    "max_prefixes": 0,
    "md5": false,
    "name": "example",
    "peer": "203.0.113.10",
    "received": 0,
    "since": "2026-10-15T12:00:00Z",
    "state": "string",
    "tenant": "acme",
    "tunnel": 0,
    "uptime_s": 0
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/bgp/sessions"

GET/v1/bgp/status

BGP summary: session count/established, received and announced prefix counts. Staff also see engine errors, total counters (accepted/withdrawn/per reject reason), and RPKI (RTR) and IRR source status; a tenant sees only its own summary

permission: bgp:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501BGP is not enabled on this appliance
Response example BGPStatusView
{
  "accepted_total": 0,
  "active": 0,
  "enabled": false,
  "engine_error": "string",
  "established": 0,
  "flaps_total": 0,
  "irr": {
    "as_sets": 0,
    "asns": 0,
    "error": "string",
    "last_fetch": "2026-10-15T12:00:00Z",
    "prefixes": 0,
    "server": "string"
  },
  "prefixes": 0,
  "rejected_total": {
    "key": 0
  },
  "rpki": [
    {
      "error": "string",
      "last_sync": "2026-10-15T12:00:00Z",
      "roas": 0,
      "serial": 0,
      "server": "string",
      "synced": false,
      "version": 0
    }
  ],
  "running": false,
  "sessions": 0,
  "static_routes": [
    {
      "advertised": false,
      "error": "string",
      "prefix": "203.0.113.0/24"
    }
  ],
  "withdrawn_total": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/bgp/status"

Reports

Attack and periodic reports (PDF).

GET/v1/reports

Generated reports (newest first). The tenant role sees ONLY its own reports (definition/generator/trigger fields are removed)

permission: report:read

Parameters

NameInTypeDescription
typequerystring (monthly_summary | tenant_sla | incident)
periodquerystringe.g. 2026-09
limitqueryintegerdefault 100, max 500

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Reports are not configured
Response example array of ReportMeta
[
  {
    "by": "string",
    "bytes": 0,
    "created": "2026-10-15T12:00:00Z",
    "def": "string",
    "from": "2026-10-15T12:00:00Z",
    "id": "string",
    "name": "example",
    "pages": 0,
    "period": "string",
    "sha256": "string",
    "tenant": "acme",
    "to": "2026-10-15T12:00:00Z",
    "trigger": "string",
    "type": "attack.start"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/reports"

GET/v1/reports/{id}

Report metadata (another tenant's report returns 404)

permission: report:read

Parameters

NameInTypeDescription
id requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Reports are not configured
Response example ReportMeta
{
  "by": "string",
  "bytes": 0,
  "created": "2026-10-15T12:00:00Z",
  "def": "string",
  "from": "2026-10-15T12:00:00Z",
  "id": "string",
  "name": "example",
  "pages": 0,
  "period": "string",
  "sha256": "string",
  "tenant": "acme",
  "to": "2026-10-15T12:00:00Z",
  "trigger": "string",
  "type": "attack.start"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/reports/{id}"

GET/v1/reports/{id}/pdf

The report's PDF file (Content-Disposition: attachment, digest is verified)

permission: report:read

Parameters

NameInTypeDescription
id requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
500File is corrupted (digest mismatch)
501Reports are not configured
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/reports/{id}/pdf"

Account & usage

Customers and traffic usage for billing.

GET/v1/tenants

Tenants (the tenant role sees only itself): quota status, prefixes, active attacks

permission: tenant:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of TenantView
[
  {
    "active_attacks": 0,
    "auth_prefixes": [
      "string"
    ],
    "can_edit_lists": false,
    "can_edit_rules": false,
    "can_set_mode": false,
    "id": "string",
    "list_limit": 0,
    "managed": false,
    "max_prefixes": 0,
    "name": "example",
    "plan": "string",
    "prefixes": [
      {
        "id": 1,
        "managed": false,
        "mode": "enforce",
        "prefix": "203.0.113.0/24"
      }
    ],
    "quota": {
      "now_bps": 0,
      "percent": 0,
      "quota_bps": 0,
      "state": "string"
    },
    "rule_limit": 0,
    "status": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tenants"

GET/v1/tenants/{id}

Single tenant

permission: tenant:read

Parameters

NameInTypeDescription
id requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example TenantView
{
  "active_attacks": 0,
  "auth_prefixes": [
    "string"
  ],
  "can_edit_lists": false,
  "can_edit_rules": false,
  "can_set_mode": false,
  "id": "string",
  "list_limit": 0,
  "managed": false,
  "max_prefixes": 0,
  "name": "example",
  "plan": "string",
  "prefixes": [
    {
      "id": 1,
      "managed": false,
      "mode": "enforce",
      "prefix": "203.0.113.0/24"
    }
  ],
  "quota": {
    "now_bps": 0,
    "percent": 0,
    "quota_bps": 0,
    "state": "string"
  },
  "rule_limit": 0,
  "status": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tenants/{id}"

GET/v1/tenants/{id}/usage

Tenant usage samples (5 min); aggregated by step

permission: usage:read

Parameters

NameInTypeDescription
id requiredpathstring
fromquerystring
toquerystring
stepquerystring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example array of UsageSample
[
  {
    "clean_bps_avg": 0,
    "clean_bps_peak": 0,
    "clean_bytes": 0,
    "drop_bps_peak": 0,
    "drop_bytes": 0,
    "partial": false,
    "seconds": 0,
    "start": "2026-10-15T12:00:00Z",
    "tenant": "acme",
    "total_bytes": 0
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/tenants/{id}/usage"

GET/v1/usage

Monthly usage/billing report (TB, 95th percentile, attacks); the tenant role sees only itself

permission: usage:read

Parameters

NameInTypeDescription
monthquerystring
formatquerystring (json | csv)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example UsageReport
{
  "clean_tb": 0,
  "from": "2026-10-15T12:00:00Z",
  "generated": "2026-10-15T12:00:00Z",
  "month": "string",
  "tenants": [
    {
      "attack_seconds": 0,
      "attacks": 0,
      "avg_clean_bps": 0,
      "clean_bytes": 0,
      "clean_tb": 0,
      "drop_bytes": 0,
      "name": "example",
      "p95_clean_bps": 0,
      "peak_clean_bps": 0,
      "plan": "string",
      "quota_bps": 0,
      "quota_exceeded_samples": 0,
      "samples": 0,
      "tenant": "acme",
      "total_bytes": 0
    }
  ],
  "to": "2026-10-15T12:00:00Z"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/usage"

GeoIP

Country / ASN lookup.

GET/v1/geo/asn-names

ASN organization names (from MaxMind ASN data; e.g. 13335 → Cloudflare, Inc.). asn: up to 200 comma-separated ASNs (AS prefix optional). Unknown ones are omitted from the response; empty if there is no database

permission: prefix:read

Parameters

NameInTypeDescription
asnquerystring

Responses

200Success
400Invalid ASN / too many ASNs
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example ASNNamesResponse
{
  "names": {
    "key": "string"
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/geo/asn-names"

System

Appliance health, interfaces, license and metrics.

GET/v1/health

Health

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example HealthResponse
{
  "status": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://portal.wireshield.network/v1/health"

Schemas

ASNNamesResponse

names requiredmap of string

ArchiveFlows

archive requiredArchiveMeta
summary requiredFlowSummary

ArchiveMeta

closed requiredboolean
dropped requiredinteger (int64)
endstring (date-time) | null
id requiredstring
merged requiredinteger (int64)
partialboolean
prefix requiredstring
prefix_id requiredinteger (int32)
records requiredinteger (int64)
start requiredstring (date-time)
truncated requiredboolean

ArchiveSamples

archive requiredArchiveMeta
next_offset requiredinteger (int64)
samples requiredarray of Rec

AttackRecord

action requiredstring
bps requirednumber
bystring
deadlinestring (date-time) | null
decisionstring
detect_latency_msinteger (int64)
dropped_packetsinteger (int64)
duration_snumber
event requiredstring
id requiredinteger (int32)
incidentstring
on_timeoutstring
peak_bpsnumber
peak_ppsnumber
pps requirednumber
prefix requiredstring
resumedboolean
targetstring
time requiredstring (date-time)
topany
vector requiredstring
vectorsarray of string

AttackseriesPoint

drop_bps requirednumber
drop_pps requirednumber
in_bps requirednumber
in_pps requirednumber
t requiredinteger (int64)

BGPIRRView

as_sets requiredinteger (int64)
asns requiredinteger (int64)
errorstring
last_fetchstring (date-time) | null
prefixes requiredinteger (int64)
server requiredstring

BGPPrefixView

accepted requiredboolean
advertised requiredboolean
as_path requiredarray of integer (int32)
errorstring
irr requiredstring
origin requiredinteger (int32)
peer requiredstring
prefix requiredstring
reasonstring
routed requiredboolean
rpki requiredstring
sincestring (date-time) | null
status requiredstring
tenant requiredstring
tunnel requiredinteger (int32)
warnings requiredarray of string

BGPRPKIView

errorstring
last_syncstring (date-time) | null
roas requiredinteger (int64)
serial requiredinteger (int32)
server requiredstring
synced requiredboolean
version requiredinteger (int32)

BGPSessionView

accepted requiredinteger (int64)
asn requiredinteger (int32)
errorstring
gtsm requiredboolean
kind requiredstring
max_prefixesinteger (int64)
md5 requiredboolean
name requiredstring
peer requiredstring
received requiredinteger (int64)
sincestring (date-time) | null
state requiredstring
tenantstring
tunnelinteger (int32)
uptime_s requiredinteger (int64)

BGPStaticView

advertised requiredboolean
errorstring
prefix requiredstring

BGPStatusView

accepted_totalinteger (int64)
active requiredinteger (int64)
enabled requiredboolean
engine_errorstring
established requiredinteger (int64)
flaps_totalinteger (int64)
irrBGPIRRView | null
prefixes requiredinteger (int64)
rejected_totalmap of integer (int64)
rpkiarray of BGPRPKIView
running requiredboolean
sessions requiredinteger (int64)
static_routesarray of BGPStaticView
withdrawn_totalinteger (int64)

Capabilities

bgp requiredboolean
flowspec requiredboolean
gre requiredboolean
incident_notes requiredboolean
incident_terminate requiredboolean
incidents requiredboolean
interfaces requiredboolean
license requiredboolean
notifications requiredboolean
pcap requiredboolean
protection_editor requiredboolean
reports_pdf requiredboolean
rtbh requiredboolean
sampling requiredboolean
telemetry requiredboolean
tenants requiredboolean
threat_intel requiredboolean
updates requiredboolean
usage_billing requiredboolean
users requiredboolean

ClassReport

bps requiredQuantiles
current requiredLearnThreshold
name requiredstring
pps requiredQuantiles
suggested requiredLearnThreshold

ClassStat

excessnumber
name requiredstring
packets requirednumber

ClassView

classes requiredarray of NamedStats
id requiredinteger (int32)
prefix requiredstring

ConfigMatch

any requiredboolean
asninteger (int32)
countrystring
dst_port requiredstring
fragment requiredstring
icmp_code requiredinteger (int64) | null
icmp_type requiredinteger (int64) | null
length requiredstring
payloadPayloadMatch | null
proto requiredstring
src_port requiredstring
tcp_flags requiredstring
ttl requiredstring

CustomRuleRequest

action requiredstring
bpsnumber
disabledboolean
expiresstring (date-time) | null
match requiredConfigMatch
namestring
ppsnumber
priority requiredinteger (int64)
scopestring
sourcestring
when requiredstring

CustomRuleView

action requiredstring
active requiredboolean
added requiredstring (date-time)
bpsnumber
bystring
disabledboolean
expiresstring (date-time) | null
id requiredinteger (int32)
match requiredConfigMatch
namestring
ppsnumber
prefix requiredinteger (int32)
priority requiredinteger (int64)
scopestring
sourcestring
stats requiredStats
updatedstring (date-time)
when requiredstring

CustomRulesView

can_edit requiredboolean
configured_mode requiredstring
limit requiredinteger (int64)
prefix requiredstring
prefix_id requiredinteger (int32)
rules requiredarray of CustomRuleView
tenantstring

EscalationView

actionstring
advertised requiredboolean
created requiredstring (date-time)
created_bystring
dst_portsstring
errorstring
expired requiredboolean
expires requiredstring (date-time)
id requiredinteger (int32)
kind requiredstring
lengthstring
prefix requiredstring
protostring
rate_bpsinteger (int64)
reasonstring
remaining_s requirednumber
source requiredstring
src_portsstring
src_prefixstring
status requiredstring
tenant requiredstring

Flow

bytes_est requiredinteger (int64)
dportinteger (int32)
dst requiredstring
first_ms requiredinteger (int64)
last_ms requiredinteger (int64)
packets_est requiredinteger (int64)
proto requiredinteger (int32)
samples requiredinteger (int64)
sportinteger (int32)
src requiredstring
verdict requiredstring

FlowSummary

bytes_est requiredinteger (int64)
distinct_sources requiredinteger (int64)
flows requiredarray of Flow
packets_est requiredinteger (int64)
total_flows requiredinteger (int64)
truncated requiredboolean

HealthResponse

status requiredstring

HealthSummary

cpu_avg_pct requirednumber
cpu_max_pct requirednumber
disk_free_pct requirednumber
hostname requiredstring
issues requiredarray of string
load1 requirednumber
mem_used_pct requirednumber
status requiredstring
uptime_s requirednumber
version requiredstring

HostInfo

addr requiredstring
stats requiredStats

HostRow

addr requiredstring
est_pps requirednumber | null
est_share requirednumber | null
stats requiredStats

Identity

name requiredstring
pid requiredinteger (int64)
read_onlyboolean
remotestring
restrictedstring
role requiredstring
tenantstring
uid requiredinteger (int64)
viastring

IncidentApproval

deadlinestring (date-time) | null
decided_atstring (date-time) | null
decided_bystring
decisionstring
on_timeoutstring
since requiredstring (date-time)
status requiredstring
wait_snumber

IncidentDetail

action requiredstring
approvalIncidentApproval | null
detect_latency_ms requiredinteger (int64)
dropped_packets requiredinteger (int64)
duration_s requirednumber
end requiredstring (date-time) | null
end_action requiredstring
id requiredstring
note_count requiredinteger (int64)
notes requiredarray of IncidentNote
peak_bps requirednumber
peak_pps requirednumber
prefix requiredstring
prefix_id requiredinteger (int32)
resumed requiredboolean
start requiredstring (date-time)
start_bps requirednumber
start_pps requirednumber
status requiredstring
tenantstring
terminated_bystring
top_endany
top_startany
vector requiredstring
vectors requiredarray of string

IncidentList

items requiredarray of IncidentView
next requiredstring | null
total requiredinteger (int64)

IncidentNote

author requiredstring
text requiredstring
time requiredstring (date-time)

IncidentView

action requiredstring
approvalIncidentApproval | null
detect_latency_ms requiredinteger (int64)
dropped_packets requiredinteger (int64)
duration_s requirednumber
end requiredstring (date-time) | null
end_action requiredstring
id requiredstring
note_count requiredinteger (int64)
peak_bps requirednumber
peak_pps requirednumber
prefix requiredstring
prefix_id requiredinteger (int32)
resumed requiredboolean
start requiredstring (date-time)
start_bps requirednumber
start_pps requirednumber
status requiredstring
tenantstring
terminated_bystring
top_endany
top_startany
vector requiredstring
vectors requiredarray of string

LearnReport

attack_s requirednumber
classes requiredarray of ClassReport
last_seen requiredstring (date-time)
min_observed_s requirednumber
observed_s requirednumber
prefix_id requiredinteger (int32)
ready requiredboolean
since requiredstring (date-time)
suggested_thresholds_json requiredstring
would_actionsarray of Would

LearnThreshold

bps requirednumber
pps requirednumber

LearningView

learning requiredboolean
prefix requiredstring
prefix_id requiredinteger (int32)
reportLearnReport | null
tenantstring

ModeRequest

mode requiredstring
reasonstring

ModeResponse

id requiredinteger (int32)
mode requiredstring
prefix requiredstring

MyChannel

enabled requiredboolean
id requiredstring
name requiredstring
selfboolean
target requiredstring
type requiredstring

MyDelivery

channel requiredstring
result requiredstring
time requiredstring (date-time)
title requiredstring
type requiredstring

MyGroup

id requiredinteger (int32)
prefixes requiredarray of MyPrefix

MyLimiter

bps requirednumber
name requiredstring
pps requirednumber
scope requiredstring

MyNotifications

channels requiredarray of MyChannel
history requiredarray of MyDelivery

MyNotifyInput

enabled requiredboolean
events requiredarray of string
language requiredstring
recipients requiredarray of string

MyNotifySettings

available requiredboolean
enabled requiredboolean
event_types requiredarray of string
events requiredarray of string
language requiredstring
recipients requiredarray of string
senderstring

MyNotifyTestResult

ok requiredboolean

MyPrefix

cidr requiredstring
configured requiredstring
descriptionstring
group requiredinteger (int32)
id requiredinteger (int32)
mode requiredstring
profile requiredinteger (int32)

MyProfile

features requiredarray of string
id requiredinteger (int32)
name requiredstring
proto_allow requiredarray of string
rules requiredarray of MyRule

MyProtection

groups requiredarray of MyGroup
limiters requiredarray of MyLimiter
name requiredstring
plan requiredstring
prefixes requiredarray of MyPrefix
profiles requiredarray of MyProfile
quota_bps requirednumber
tenant requiredstring

MyRule

action requiredstring
drops requiredinteger (int64)
limiterstring
match requiredstring
name requiredstring
packets requiredinteger (int64)

NamedStats

name requiredstring
stats requiredStats

Overview

active_incidents requiredarray of IncidentView
capabilities requiredCapabilities
health requiredHealthSummary | null
prefixes requiredPrefixSummary
rates requiredRateSnapshot | null
recent_incidents requiredarray of IncidentView
sample_rate requiredinteger (int32)
scope requiredstring
tenantstring
time requiredstring (date-time)
top_prefixes requiredarray of TopEntry
top_targets requiredarray of TopEntry
totals requiredOverviewTotals

OverviewTotals

bytes requiredinteger (int64)
drop_bytes requiredinteger (int64)
drop_packets requiredinteger (int64)
packets requiredinteger (int64)
wd_packets requiredinteger (int64)

PayloadMatch

asciistring
hexstring
maskstring
offsetinteger (int64) | null
templatestring

PrefixListAdd

cidr requiredstring
commentstring

PrefixListEntry

added requiredstring (date-time)
bystring
cidr requiredstring
commentstring
kind requiredstring
prefix requiredinteger (int32)

PrefixListView

allow requiredarray of PrefixListEntry
can_edit requiredboolean
deny requiredarray of PrefixListEntry
limit requiredinteger (int64)
prefix requiredstring
prefix_id requiredinteger (int32)
tenantstring

PrefixSummary

bypass requiredinteger (int64)
enforce requiredinteger (int64)
sensor requiredinteger (int64)
total requiredinteger (int64)

PrefixView

configured_modestring
descriptionstring
group requiredinteger (int32)
id requiredinteger (int32)
mode requiredinteger (int32)
mode_name requiredstring
prefix requiredstring
profile requiredinteger (int32)
stats requiredStats
tenantstring

Quantiles

max requirednumber
p50 requirednumber
p95 requirednumber
p99 requirednumber

QuotaView

now_bps requirednumber
percent requirednumber
quota_bps requirednumber
state requiredstring

RateSnapshot

clean_bps requirednumber
drop_bps requirednumber
drop_pps requirednumber
rx_bps requirednumber
rx_pps requirednumber
wd_bps requirednumber
window_secs requiredinteger (int64)

ReasonStat

name requiredstring
packets requirednumber
peak_pps requirednumber

Rec

cstring
dpinteger (int32)
dst requiredstring
flagsinteger (int32)
len requiredinteger (int32)
ninteger (int32)
proto requiredinteger (int32)
rstring
spinteger (int32)
src requiredstring
t requiredinteger (int64)
ttlinteger (int32)
v requiredstring
w requiredinteger (int64)

ReportMeta

bystring
bytes requiredinteger (int64)
created requiredstring (date-time)
defstring
from requiredstring (date-time)
id requiredstring
name requiredstring
pages requiredinteger (int64)
period requiredstring
sha256 requiredstring
tenantstring
to requiredstring (date-time)
triggerstring
type requiredstring

Series

classesarray of ClassStat
endstring (date-time) | null
id requiredstring
partialboolean
points requiredarray of AttackseriesPoint
prefix requiredstring
prefix_id requiredinteger (int32)
reasonsarray of ReasonStat
start requiredstring (date-time)
step_s requiredinteger (int64)

SeriesPoint

clean_bps requirednumber
drop_bps requirednumber
drop_pps requirednumber
rx_bps requirednumber
rx_pps requirednumber
t requiredinteger (int64)
wd_bps requirednumber

SeriesResponse

from requiredstring (date-time)
points requiredarray of SeriesPoint
prefix_idinteger (int32) | null
res requiredstring
to requiredstring (date-time)

Share

est_pps requirednumber
name requiredstring
share requirednumber

Stats

bytes requiredinteger (int64)
drop_bytes requiredinteger (int64)
drop_packets requiredinteger (int64)
packets requiredinteger (int64)
wd_bytes requiredinteger (int64)
wd_packets requiredinteger (int64)

TenantPrefix

id requiredinteger (int32)
managed requiredboolean
mode requiredstring
prefix requiredstring

TenantView

active_attacks requiredinteger (int64)
auth_prefixes requiredarray of string
can_edit_lists requiredboolean
can_edit_rules requiredboolean
can_set_mode requiredboolean
id requiredstring
list_limit requiredinteger (int64)
managed requiredboolean
max_prefixes requiredinteger (int64)
name requiredstring
plan requiredstring
prefixes requiredarray of TenantPrefix
quota requiredQuotaView
rule_limit requiredinteger (int64)
status requiredstring

TokenInfo

cidrsarray of string
created requiredstring (date-time)
expires requiredstring (date-time)
id requiredstring
last_usedstring (date-time)
name requiredstring
read_only requiredboolean
user requiredstring

TopEntry

ccstring
est_pps requirednumber
key requiredstring
max_err_pps requirednumber
share requirednumber

TopResponse

available requiredboolean
sample_rate requiredinteger (int32)
snapshotTopSnapshot | null

TopSnapshot

asnsarray of TopEntry
classes requiredarray of Share
complete requiredboolean
countriesarray of TopEntry
distinct_sources_est requirednumber
dst_ports requiredarray of TopEntry
est_bps requirednumber
est_pps requirednumber
estimated requiredboolean
prefix_id requiredinteger (int32)
prefixesarray of TopEntry
protocols requiredarray of Share
reasons requiredarray of Share
samples requiredinteger (int64)
sizes requiredarray of Share
source_nets requiredarray of TopEntry
sources requiredarray of TopEntry
src_ports requiredarray of TopEntry
targets requiredarray of TopEntry
tcp_flags requiredarray of Share
verdicts requiredarray of Share
window_secs requirednumber
window_start requiredstring (date-time)

TunnelBGP

as_setstring
asn requiredinteger (int32)
disabledboolean
groupinteger (int32)
irrstring
max_len_v4integer (int64)
max_len_v6integer (int64)
max_prefixesinteger (int64)
modestring
profileinteger (int32)
rpkistring

TunnelHealthView

bgpstring
errorstring
failures requiredinteger (int64)
last_okstring (date-time) | null
last_rtt_ms requirednumber
loss_pct requirednumber
overall requiredstring
probe requiredstring
probes requiredinteger (int64)
reasonstring
rtt_ms requirednumber
sincestring (date-time) | null

TunnelLive

addrs requiredarray of string
errorstring
healthTunnelHealthView | null
ifname requiredstring
last_actionstring
mtu requiredinteger (int64)
oper_up requiredboolean
present requiredboolean
rx_bytes requiredinteger (int64)
rx_dropped requiredinteger (int64)
rx_errors requiredinteger (int64)
rx_packets requiredinteger (int64)
tx_bytes requiredinteger (int64)
tx_dropped requiredinteger (int64)
tx_errors requiredinteger (int64)
tx_packets requiredinteger (int64)
up requiredboolean

TunnelSystem

clamp_errorstring
errors requiredinteger (int64)
ip_forward requiredboolean
oper_up requiredinteger (int64)
present requiredinteger (int64)
tunnels requiredinteger (int64)

TunnelView

bgpTunnelBGP | null
commentstring
disabled requiredboolean
id requiredinteger (int32)
inner_localstring
inner_peerstring
keyinteger (int32) | null
live requiredTunnelLive
local requiredstring
mss_clamp requiredboolean
mtu requiredinteger (int64)
name requiredstring
no_probe requiredboolean
remote requiredstring
routes requiredarray of string
tenant requiredstring
ttl requiredinteger (int64)

UsageReport

clean_tb requirednumber
from requiredstring (date-time)
generated requiredstring (date-time)
month requiredstring
tenants requiredarray of UsageTenantReport
to requiredstring (date-time)

UsageSample

clean_bps_avg requirednumber
clean_bps_peak requirednumber
clean_bytes requiredinteger (int64)
drop_bps_peak requirednumber
drop_bytes requiredinteger (int64)
partialboolean
seconds requirednumber
start requiredstring (date-time)
tenant requiredstring
total_bytes requiredinteger (int64)

UsageTenantReport

attack_seconds requirednumber
attacks requiredinteger (int64)
avg_clean_bps requirednumber
clean_bytes requiredinteger (int64)
clean_tb requirednumber
drop_bytes requiredinteger (int64)
name requiredstring
p95_clean_bps requirednumber
peak_clean_bps requirednumber
plan requiredstring
quota_bps requirednumber
quota_exceeded_samples requiredinteger (int64)
samples requiredinteger (int64)
tenant requiredstring
total_bytes requiredinteger (int64)

Would

kind requiredstring
reasonstring
target requiredstring
time requiredstring (date-time)