API WireShield MSSP API v1.0.30

WireShield MSSP API

Operate the DDoS protection service for all customers: protection policy, attacks, mitigation approvals, upstream mitigation, tunnels and BGP, integrations, reports, customers and usage. Requests are authenticated with an API token created in the MSSP console.

Base URL: https://mssp.example.com:8443

Getting started

The API is a JSON-over-HTTPS REST API. It is the same API the MSSP console uses: everything you can do in the console for all customers can be automated.

  1. Create a token. Sign in to the MSSP console, 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://mssp.example.com:8443/v1/whoami
curl -H "Authorization: Bearer $WS_TOKEN" https://mssp.example.com:8443/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>.
  • Many configuration changes accept ?dry_run=true: the request is fully validated and the result is returned, but nothing is applied.
  • Every change is written to the appliance's tamper-evident audit log with the token's user name.

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 (operator: read and change; viewer: read only).

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.
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://mssp.example.com:8443/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.
mitigation.pendingA mitigation is waiting for operator approval.
protection.changed, incident.noteProtection configuration changed; a note was added to an attack.
report.ready, system.alertA report was generated; an appliance alert (integrity, tunnel, feed, report failure).
bgp.session.up/down, bgp.prefix, tunnel.health, escalationRouting, tunnel and upstream mitigation changes.
capture, selfprot, export, licensePacket capture, self-protection, flow export and license changes.

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://mssp.example.com:8443/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"])

Webhooks

Webhook channels (Integrations) POST a JSON document to your URL for every event selected by a notification rule. Channels and rules are managed with the Integrations endpoints or in the console.

POST /your/endpoint HTTP/1.1
Content-Type: application/json
User-Agent: WireShield/1.0.30
X-WireShield-Timestamp: 1792065603
X-WireShield-Signature: sha256=5f2c…

{"schema":1,"id":"48211","event":"attack.start","severity":"high","time":"2026-10-15T12:00:03Z",
 "host":"edge-01","version":"1.0.30","prefix_id":7,"prefix":"203.0.113.0/24","tenant":"acme",
 "title":"Attack started: 203.0.113.10 — UDP flood","body":"Target: 203.0.113.10 (203.0.113.0/24)\n…",
 "fields":{"vector":"udp_flood","action":"enforce","pps":"1840000","bps":"7900000000",
           "target":"203.0.113.10","incident":"7-1792065603"}}

severity is one of info, notice, warning, high, critical. fields values are strings. The document format is stable; new fields may be added.

Verifying the signature

When the channel has a secret, the signature is hex(HMAC-SHA256(secret, timestamp + "." + raw_body)). Verify it on the raw request body and reject old timestamps to prevent replays:

import hmac, hashlib, time

def verify(secret: bytes, ts: str, sig: str, body: bytes) -> bool:
    if abs(time.time() - int(ts)) > 300:
        return False
    want = "sha256=" + hmac.new(secret, ts.encode() + b"." + body, hashlib.sha256).hexdigest()
    return hmac.compare_digest(want, sig)

Delivery

  • Any 2xx response is success. Other responses and timeouts (15 s) are retried after 1 s, 5 s, 30 s, 2 min and 10 min, then dropped and shown in the delivery history.
  • Each channel sends at most 60 messages per minute; HTTPS is required unless the channel explicitly allows plain HTTP.
  • The slack format sends {"text": "title\nbody"} for Slack-compatible incoming webhooks instead of the document above.
  • Customer-scoped channels only receive that customer's attack, mode and report events.

Syslog & CEF

Syslog channels send RFC 5424 messages over UDP, TCP or TLS. The message body is either ArcSight CEF (default) or the same JSON document as webhooks.

<131>1 2026-10-15T12:00:03.000Z edge-01 wireshield - attack_start - CEF:0|WireShield|DDoS Appliance|1.0.30|attack_start|Attack started: 203.0.113.10 — UDP flood|8|rt=1792065603000 externalId=48211 msg=Attack started: 203.0.113.10 — UDP flood cs1Label=vector cs1=udp_flood cs2Label=prefix cs2=203.0.113.0/24 cs3Label=tenant cs3=acme cs4Label=action cs4=enforce

CEF fields

KeyContent
Signature IDEvent type with _ (attack_start, attack_end, prefix_mode, system_alert, …)
Severity1 info, 3 notice, 5 warning, 8 high, 10 critical
rt, externalId, msgEvent time (ms), event id, title
cs1–cs5vector, prefix, tenant, action, by (user who made the change)
cn1–cn3peakPps, peakBps, durationSeconds (attack end)

The syslog facility (default local0) and application name (default wireshield) are configurable per channel. For TLS, a private CA can be set on the channel.

Prometheus metrics

GET /metrics serves Prometheus text format with data-plane counters, per-prefix rates, attack state, notification delivery counters and appliance health. Use a read-only token restricted to your Prometheus server's address:

scrape_configs:
  - job_name: wireshield
    scheme: https
    metrics_path: /metrics
    authorization:
      type: Bearer
      credentials_file: /etc/prometheus/wireshield.token
    static_configs:
      - targets: ["portal.wireshield.network:8443"]

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

read-only users

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://mssp.example.com:8443/v1/auth/tokens"

GET/v1/whoami

Caller identity

read-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/incidents/{id}"

POST/v1/incidents/{id}/notes

Add a note to an attack (management roles only; at most 50 notes, 1000 characters)

permission: incident:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring

Request body NoteRequest

FieldType
text requiredstring
{
  "text": "string"
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Note limit
422Empty or too long note
429Rate limited
501Not configured
503Audit record could not be written (operation not performed)
Response example IncidentNote
{
  "author": "string",
  "text": "string",
  "time": "2026-10-15T12:00:00Z"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"text":"string"}' \
  "https://mssp.example.com:8443/v1/incidents/{id}/notes"

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:readread-only users

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://mssp.example.com:8443/v1/incidents/{id}/series"

POST/v1/incidents/{id}/terminate

Manually terminate an ongoing attack: the prefix is switched to SENSOR and new detection is held off for 120 s (management roles only). Optional body: relearn: true → the traffic was normal, the learned baseline is set to the current level (the same level will not open a new incident)

permission: incident:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring

Request body TerminateRequest

FieldType
relearnboolean
{
  "relearn": false
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Incident has already ended or the mode could not be changed
429Rate limited
501Not configured
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"relearn":false}' \
  "https://mssp.example.com:8443/v1/incidents/{id}/terminate"

GET/v1/overview

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

permission: prefix:readread-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/prefixes/{id}/hosts"

Prefixes & attacks

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

GET/v1/ackval

ACK/RST validation: counts of learned (handshake observed) and pending sources

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example AckInfo
{
  "Known4": 0,
  "Known6": 0,
  "Pending4": 0,
  "Pending6": 0,
  "Total4": 0,
  "Total6": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ackval"

GET/v1/attacks

Attack events (tenant: own prefixes only)

permission: attack:readread-only users

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://mssp.example.com:8443/v1/attacks"

GET/v1/classes

Per-prefix traffic class counters

permission: prefix:readread-only users

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://mssp.example.com:8443/v1/classes"

GET/v1/counters

Global counters and drop reasons

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example Counters
{
  "global": [
    {
      "name": "example",
      "stats": {
        "bytes": null,
        "drop_bytes": null,
        "drop_packets": null,
        "packets": null,
        "wd_bytes": null,
        "wd_packets": null
      }
    }
  ],
  "reasons": [
    {
      "name": "example",
      "stats": {
        "bytes": null,
        "drop_bytes": null,
        "drop_packets": null,
        "packets": null,
        "wd_bytes": null,
        "wd_packets": null
      }
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/counters"

GET/v1/hosts

Top destinations by traffic (tenant: own prefixes only)

permission: prefix:readread-only users

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://mssp.example.com:8443/v1/hosts"

GET/v1/limiters

Rate limiters

permission: global:readread-only users

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 LimiterInfo
[
  {
    "bps": 0,
    "buckets": 0,
    "burst_bytes": 0,
    "burst_pkts": 0,
    "id": 1,
    "pps": 0,
    "scope": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/limiters"

GET/v1/lists

Allow/deny lists

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example Lists
{
  "allow": [
    "string"
  ],
  "deny": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/lists"

GET/v1/prefixes

Protected prefixes (tenant: own only)

permission: prefix:readread-only users

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://mssp.example.com:8443/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://mssp.example.com:8443/v1/prefixes/{id}/mode"

GET/v1/protos

Protocol counters

permission: global:readread-only users

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 ProtoView
[
  {
    "proto": 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://mssp.example.com:8443/v1/protos"

GET/v1/rules

Profile rules and hit counters

permission: global:readread-only users

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 RuleInfo
[
  {
    "action": 0,
    "flags": 0,
    "index": 0,
    "limiter": 0,
    "match": "string",
    "profile": 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://mssp.example.com:8443/v1/rules"

GET/v1/synauth

SYN authentication status

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example SynAuthInfo
{
  "SecretSet": false,
  "Total4": 0,
  "Total6": 0,
  "Validated4": 1,
  "Validated6": 1,
  "WindowNS": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/synauth"

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:readread-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/prefixes/{id}/top"

GET/v1/protos/series

Overall protocol breakdown time series (packets/s; TCP, UDP, ICMP+ICMPv6, other). From the data plane's real counters (not sampling). res: 10s (last 1 hour, default) | 1m (last 24 hours); from/to RFC3339. Kept in memory: starts empty when the service restarts

permission: global:readread-only users

Parameters

NameInTypeDescription
resquerystring10s | 1m
fromquerystringRFC3339
toquerystringRFC3339

Responses

200Success
400Invalid resolution or range
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Telemetry is disabled
Response example ProtoSeriesResponse
{
  "from": "2026-10-15T12:00:00Z",
  "points": [
    {
      "icmp": 0,
      "other": 0,
      "t": 0,
      "tcp": 0,
      "udp": 0
    }
  ],
  "res": "string",
  "to": "2026-10-15T12:00:00Z"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protos/series"

GET/v1/series

Global time series

permission: global:readread-only users

Parameters

NameInTypeDescription
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
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://mssp.example.com:8443/v1/series"

GET/v1/telemetry/status

Telemetry status: sampling rate, processed/rejected samples, kernel ring drops

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Telemetry is not configured
Response example TelemetryStatus
{
  "adaptive_adjustments": 0,
  "adaptive_enabled": false,
  "adaptive_max_rate": 0,
  "adaptive_min_rate": 0,
  "adaptive_target_samples_per_sec": 0,
  "decode_errors": 0,
  "disk_bytes": 0,
  "disk_enabled": false,
  "disk_errors": 0,
  "disk_segments": 0,
  "kernel_sample_lost": 0,
  "kernel_sampled": 0,
  "prefix_states": 0,
  "read_errors": 0,
  "sample_rate": 0,
  "samples_processed": 0,
  "samples_rejected": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/telemetry/status"

GET/v1/top

Global sample-based summary (including per-prefix breakdown)

permission: global:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
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://mssp.example.com:8443/v1/top"

GET/v1/top/series

Dimension breakdown time series of overall traffic (Traffic Analyzer): dim = country | asn | protocol | port | target; metric = bps (default) | pps; res = 10s (last 1 hour) | 1m (last 24 hours); n = at most 10 keys (default 8). keys are sorted by their total over the range, values are aligned with them, other is the sum of the remaining keys. Estimated from sampling; kept in memory (cleared when the service restarts)

permission: global:readread-only users

Parameters

NameInTypeDescription
dimquerystring
metricquerystring
resquerystring
fromquerystring
toquerystring
nqueryinteger

Responses

200Success
400Invalid dimension/metric/resolution/range
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Telemetry is disabled
Response example DimSeriesResponse
{
  "dim": "string",
  "keys": [
    "string"
  ],
  "metric": "string",
  "points": [
    {
      "other": 0,
      "t": 0,
      "values": [
        0
      ]
    }
  ],
  "res": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/top/series"

Forensics

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

GET/v1/captures

Captures (newest first; running ones with live counters)

permission: capture:read

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Capture not found
429Rate limited
501PCAP capture is disabled
Response example CaptureList
{
  "items": [
    {
      "by": "string",
      "bytes": 0,
      "duration_s": 0,
      "ended": "2026-10-15T12:00:00Z",
      "ends": "2026-10-15T12:00:00Z",
      "error": "string",
      "file_size": 0,
      "filter": {
        "dport": null,
        "dst": null,
        "proto": null,
        "sport": null,
        "src": null
      },
      "filtered": 0,
      "id": "string",
      "incident_id": "string",
      "kernel_lost": 0,
      "kernel_rate_limited": 0,
      "max_pps": 0,
      "packets": 0,
      "prefix": "203.0.113.0/24",
      "prefix_id": 1,
      "rate_limited_user": 0,
      "snaplen": 0,
      "source": "string",
      "started": "2026-10-15T12:00:00Z",
      "status": "string",
      "verdicts": [
        "string"
      ]
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/captures"

POST/v1/captures

Start a time-limited PCAP capture for a prefix: XDP copies the first snaplen bytes of each packet (including payload!) to a second ring; the verdict is not affected. The duration is also enforced in the data plane (it ends even if the service dies). One capture per prefix, at most 8 concurrent; file at most 256 MiB; max_pps is the total packets/s limit. The filter (src/dst/proto/sport/dport) is applied to the captured bytes. An audit record is written

permission: capture:writeaudited

Request body CaptureRequest

FieldType
duration_s requiredinteger (int64)
filter requiredFilterSpec
max_pps requiredinteger (int64)
prefix_id requiredinteger (int32)
snaplen requiredinteger (int64)
verdicts requiredarray of string
{
  "duration_s": 0,
  "filter": {
    "dport": 0,
    "dst": "203.0.113.10",
    "proto": "string",
    "sport": 0,
    "src": "203.0.113.10"
  },
  "max_pps": 0,
  "prefix_id": 1,
  "snaplen": 0,
  "verdicts": [
    "string"
  ]
}

Responses

200Success
400Invalid duration/filter/verdict/limit
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Prefix not found
409A capture is already running for this prefix, or the concurrency limit is reached
429Rate limited
501PCAP capture is disabled
503Audit record could not be written (operation not performed)
Response example PcapMeta
{
  "by": "string",
  "bytes": 0,
  "duration_s": 0,
  "ended": "2026-10-15T12:00:00Z",
  "ends": "2026-10-15T12:00:00Z",
  "error": "string",
  "file_size": 0,
  "filter": {
    "dport": 0,
    "dst": "203.0.113.10",
    "proto": "string",
    "sport": 0,
    "src": "203.0.113.10"
  },
  "filtered": 0,
  "id": "string",
  "incident_id": "string",
  "kernel_lost": 0,
  "kernel_rate_limited": 0,
  "max_pps": 0,
  "packets": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "rate_limited_user": 0,
  "snaplen": 0,
  "source": "string",
  "started": "2026-10-15T12:00:00Z",
  "status": "string",
  "verdicts": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"duration_s":0,"filter":{"dport":0,"dst":"203.0.113.10","proto":"string","sport":0,"src":"203.0.113.10"},"max_pps":0,"prefix_id":1,"snaplen":0,"verdicts":["string"]}' \
  "https://mssp.example.com:8443/v1/captures"

GET/v1/captures/{id}

Capture summary: state (running|done|stopped|limit|failed|interrupted), packets/bytes, filtered out, user rate limit, kernel drops

permission: capture:read

Parameters

NameInTypeDescription
id requiredpathstringcapture ID (cap-<prefix_id>-<unix_ms>)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Capture not found
429Rate limited
501PCAP capture is disabled
Response example PcapMeta
{
  "by": "string",
  "bytes": 0,
  "duration_s": 0,
  "ended": "2026-10-15T12:00:00Z",
  "ends": "2026-10-15T12:00:00Z",
  "error": "string",
  "file_size": 0,
  "filter": {
    "dport": 0,
    "dst": "203.0.113.10",
    "proto": "string",
    "sport": 0,
    "src": "203.0.113.10"
  },
  "filtered": 0,
  "id": "string",
  "incident_id": "string",
  "kernel_lost": 0,
  "kernel_rate_limited": 0,
  "max_pps": 0,
  "packets": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "rate_limited_user": 0,
  "snaplen": 0,
  "source": "string",
  "started": "2026-10-15T12:00:00Z",
  "status": "string",
  "verdicts": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/captures/{id}"

DELETE/v1/captures/{id}

Delete a finished capture (a running one cannot be deleted). An audit record is written

permission: capture:writeaudited

Parameters

NameInTypeDescription
id requiredpathstringcapture ID (cap-<prefix_id>-<unix_ms>)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Capture not found
409Capture is running: stop it first
429Rate limited
501PCAP capture is disabled
503Audit record could not be written (operation not performed)
Response example map of any
{
  "key": null
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/captures/{id}"

GET/v1/captures/{id}/pcap

Capture file: classic libpcap (nanosecond, Ethernet); opens in tcpdump/Wireshark. Finished captures only. Every download is written to the audit chain (if it cannot be written, the download is refused)

permission: capture:readaudited

Parameters

NameInTypeDescription
id requiredpathstringcapture ID (cap-<prefix_id>-<unix_ms>)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Capture not found
409Capture is running
429Rate limited
501PCAP capture is disabled
503Audit record could not be written (operation not performed)
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/captures/{id}/pcap"

POST/v1/captures/{id}/stop

Stop a running capture (returns the summary if already finished). An audit record is written

permission: capture:writeaudited

Parameters

NameInTypeDescription
id requiredpathstringcapture ID (cap-<prefix_id>-<unix_ms>)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Capture not found
429Rate limited
501PCAP capture is disabled
503Audit record could not be written (operation not performed)
Response example PcapMeta
{
  "by": "string",
  "bytes": 0,
  "duration_s": 0,
  "ended": "2026-10-15T12:00:00Z",
  "ends": "2026-10-15T12:00:00Z",
  "error": "string",
  "file_size": 0,
  "filter": {
    "dport": 0,
    "dst": "203.0.113.10",
    "proto": "string",
    "sport": 0,
    "src": "203.0.113.10"
  },
  "filtered": 0,
  "id": "string",
  "incident_id": "string",
  "kernel_lost": 0,
  "kernel_rate_limited": 0,
  "max_pps": 0,
  "packets": 0,
  "prefix": "203.0.113.0/24",
  "prefix_id": 1,
  "rate_limited_user": 0,
  "snaplen": 0,
  "source": "string",
  "started": "2026-10-15T12:00:00Z",
  "status": "string",
  "verdicts": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/captures/{id}/stop"

GET/v1/export

IPFIX / sFlow export: configured collectors and their status (records/messages/bytes sent, queue drops, errors, last send, IPFIX active flow count). The data source is XDP samples (telemetry.sample_rate); IPFIX counters are ESTIMATES scaled by the sampling weight

permission: export:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Export is disabled
Response example ExportView
{
  "collectors": [
    {
      "active_flows": 0,
      "bytes": 0,
      "collector": {
        "active_timeout_s": null,
        "address": null,
        "agent_address": null,
        "enabled": null,
        "id": null,
        "if_index": null,
        "observation_domain": null,
        "prefix_ids": null,
        "sub_agent_id": null,
        "template_refresh_s": null,
        "transport": null,
        "type": null,
        "verdicts": null
      },
      "errors": 0,
      "last_error": "string",
      "last_send": "2026-10-15T12:00:00Z",
      "messages": 0,
      "queue_drops": 0,
      "records": 0,
      "samples": 0
    }
  ],
  "config": {
    "collectors": [
      {
        "active_timeout_s": null,
        "address": null,
        "agent_address": null,
        "enabled": null,
        "id": null,
        "if_index": null,
        "observation_domain": null,
        "prefix_ids": null,
        "sub_agent_id": null,
        "template_refresh_s": null,
        "transport": null,
        "type": null,
        "verdicts": null
      }
    ]
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/export"

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:readread-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/incidents/{id}/samples"

GET/v1/incidents/{id}/suggestions

RULE SUGGESTIONS: clusters the attack samples (verdict ≠ pass) from the attack's sample archive and derives the narrowest rules (proto, port, TCP flags, length, TTL, source country/ASN); measures each rule's side effect against the passed (pass) traffic in the SAME archive and ranks them by greedy coverage. Fully deterministic and on-device (no external service/AI). Rules are always produced as count (observe) and validated with the appliance's own compiler; NONE are applied automatically. Admin/operator only (tenants and viewers cannot see it); samples are header-level (no payload content)

permission: incident:write

Parameters

NameInTypeDescription
id requiredpathstring<prefix_id>-<start_unix>
maxqueryintegermaximum suggestions (default 5, max 20)
min_samplesqueryintegerminimum raw sample count for a cluster (default 30)
min_coveragequerynumberminimum fraction of attack weight (0-1], default 0.05

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 SuggestionsView
{
  "incident_id": "string",
  "prefix_id": 1,
  "profile_id": 1,
  "report": {
    "attack_samples": 0,
    "attack_weight": 0,
    "notes": [
      "string"
    ],
    "pass_samples": 0,
    "pass_weight": 0,
    "suggestions": [
      {
        "attack_samples": null,
        "collateral": null,
        "coverage": null,
        "pass_samples": null,
        "rationale": null,
        "recommended": null,
        "risk": null,
        "rule": null,
        "total_coverage": null
      }
    ]
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/incidents/{id}/suggestions"

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:readread-only userstext/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://mssp.example.com:8443/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:readread-only users

Parameters

NameInTypeDescription
tenantquerystringstaff only: which customer (a customer sees its own; another customer's returns 404)

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://mssp.example.com:8443/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:readread-only users

Parameters

NameInTypeDescription
tenantquerystringstaff only: which customer (a customer sees its own; another customer's returns 404)

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://mssp.example.com:8443/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

Parameters

NameInTypeDescription
tenantquerystringstaff only: which customer (a customer sees its own; another customer's returns 404)

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://mssp.example.com:8443/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

Parameters

NameInTypeDescription
tenantquerystringstaff only: which customer (a customer sees its own; another customer's returns 404)

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://mssp.example.com:8443/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:readread-only users

Parameters

NameInTypeDescription
tenantquerystringstaff only: which customer (a customer sees its own; another customer's returns 404)

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/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://mssp.example.com:8443/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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/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://mssp.example.com:8443/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://mssp.example.com:8443/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://mssp.example.com:8443/v1/prefixes/{id}/rules/{rid}"

Protection

Protection groups, profiles, rules and rate limiters.

PATCH/v1/prefixes/{id}

Change a managed prefix's profile/group/configured mode assignment (409 for static). Does not create a version; no ETag precondition. If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body PrefixPatch

FieldType
description requiredstring | null
group requiredinteger (int32) | null
mode requiredstring | null
profile requiredinteger (int32) | null
{
  "description": "string",
  "group": 0,
  "mode": "enforce",
  "profile": 0
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example PrefixChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "prefix": {
    "cidr": "203.0.113.0/24",
    "group": 0,
    "id": 1,
    "mode": "enforce",
    "profile": 0,
    "tenant": "acme"
  },
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X PATCH -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"description":"string","group":0,"mode":"enforce","profile":0}' \
  "https://mssp.example.com:8443/v1/prefixes/{id}"

GET/v1/protection

Protection configuration summary: version/ETag, static and managed record counts, compile warnings. The response ETag header is the current protection version.

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example ProtectionSummary
{
  "allow": {
    "managed": 0,
    "static": 0
  },
  "deny": {
    "managed": 0,
    "static": 0
  },
  "etag": "string",
  "groups": 0,
  "limiters": {
    "managed": 0,
    "static": 0
  },
  "prefixes": 0,
  "profiles": {
    "managed": 0,
    "static": 0
  },
  "revision": 0,
  "updated": "2026-10-15T12:00:00Z",
  "warnings": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection"

GET/v1/protection/groups

Protection groups: prefix count, tenants, modes, active attacks (unnamed groups referenced only by prefixes are implicit). The response ETag header is the current protection version.

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example array of GroupView
[
  {
    "active_attacks": 0,
    "description": "string",
    "id": 1,
    "modes": {
      "key": 0
    },
    "name": "example",
    "prefixes": 0,
    "source": "string",
    "tenants": [
      "acme"
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/groups"

POST/v1/protection/groups

Create a group (id is assigned if not given). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Group

FieldType
descriptionstring
id requiredinteger (int32)
name requiredstring
{
  "description": "string",
  "id": 1,
  "name": "example"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example GroupChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "group": {
    "description": "string",
    "id": 1,
    "name": "example"
  },
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"description":"string","id":1,"name":"example"}' \
  "https://mssp.example.com:8443/v1/protection/groups"

GET/v1/protection/groups/{id}

Group details. The response ETag header is the current protection version.

permission: protection:readread-only users

Parameters

NameInTypeDescription
id requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example GroupView
{
  "active_attacks": 0,
  "description": "string",
  "id": 1,
  "modes": {
    "key": 0
  },
  "name": "example",
  "prefixes": 0,
  "source": "string",
  "tenants": [
    "acme"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/groups/{id}"

PUT/v1/protection/groups/{id}

Replace a group. If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Group

FieldType
descriptionstring
id requiredinteger (int32)
name requiredstring
{
  "description": "string",
  "id": 1,
  "name": "example"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example GroupChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "group": {
    "description": "string",
    "id": 1,
    "name": "example"
  },
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"description":"string","id":1,"name":"example"}' \
  "https://mssp.example.com:8443/v1/protection/groups/{id}"

DELETE/v1/protection/groups/{id}

Delete a group (prefixes keep using the group ID; only the name is lost). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/groups/{id}"

GET/v1/protection/limiters

Limiters (static + managed) and the profiles using them. The response ETag header is the current protection version.

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example array of LimiterView
[
  {
    "id": 1,
    "limiter": {
      "bps": 0,
      "burst_bytes": 0,
      "burst_pps": 0,
      "name": "example",
      "pps": 0,
      "scope": "string"
    },
    "name": "example",
    "source": "string",
    "used_by": [
      "string"
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/limiters"

POST/v1/protection/limiters

Create a managed limiter. If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Limiter

FieldType
bps requirednumber
burst_bytes requiredinteger (int64)
burst_pps requiredinteger (int64)
name requiredstring
pps requirednumber
scope requiredstring
{
  "bps": 0,
  "burst_bytes": 0,
  "burst_pps": 0,
  "name": "example",
  "pps": 0,
  "scope": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example LimiterChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "limiter": {
    "bps": 0,
    "burst_bytes": 0,
    "burst_pps": 0,
    "name": "example",
    "pps": 0,
    "scope": "string"
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"bps":0,"burst_bytes":0,"burst_pps":0,"name":"example","pps":0,"scope":"string"}' \
  "https://mssp.example.com:8443/v1/protection/limiters"

GET/v1/protection/limiters/{name}

Limiter details. The response ETag header is the current protection version.

permission: protection:readread-only users

Parameters

NameInTypeDescription
name 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
501Managed state store is disabled
Response example LimiterView
{
  "id": 1,
  "limiter": {
    "bps": 0,
    "burst_bytes": 0,
    "burst_pps": 0,
    "name": "example",
    "pps": 0,
    "scope": "string"
  },
  "name": "example",
  "source": "string",
  "used_by": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/limiters/{name}"

PUT/v1/protection/limiters/{name}

Replace a managed limiter (the name cannot be changed). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Limiter

FieldType
bps requirednumber
burst_bytes requiredinteger (int64)
burst_pps requiredinteger (int64)
name requiredstring
pps requirednumber
scope requiredstring
{
  "bps": 0,
  "burst_bytes": 0,
  "burst_pps": 0,
  "name": "example",
  "pps": 0,
  "scope": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example LimiterChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "limiter": {
    "bps": 0,
    "burst_bytes": 0,
    "burst_pps": 0,
    "name": "example",
    "pps": 0,
    "scope": "string"
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"bps":0,"burst_bytes":0,"burst_pps":0,"name":"example","pps":0,"scope":"string"}' \
  "https://mssp.example.com:8443/v1/protection/limiters/{name}"

DELETE/v1/protection/limiters/{name}

Delete a managed limiter (409 if rules use it). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/limiters/{name}"

GET/v1/protection/lists

Allow/deny lists (static + managed; managed entries include note, author, time). The response ETag header is the current protection version.

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example ListsView
{
  "allow": [
    {
      "added": "2026-10-15T12:00:00Z",
      "by": "string",
      "cidr": "203.0.113.0/24",
      "comment": "string",
      "source": "string"
    }
  ],
  "deny": [
    {
      "added": "2026-10-15T12:00:00Z",
      "by": "string",
      "cidr": "203.0.113.0/24",
      "comment": "string",
      "source": "string"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/lists"

POST/v1/protection/lists/{kind}

Add an entry to an allow/deny list. The lists are GLOBAL: they affect all prefixes. If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
kind requiredpathstring (allow | deny)
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body ListEntryRequest

FieldType
cidr requiredstring
comment requiredstring
{
  "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
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"cidr":"203.0.113.0/24","comment":"string"}' \
  "https://mssp.example.com:8443/v1/protection/lists/{kind}"

DELETE/v1/protection/lists/{kind}

Remove a managed entry from the list (409 for static). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
kind requiredpathstring (allow | deny)
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced
cidrquerystringentry to delete

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/lists/{kind}"

GET/v1/protection/payload-templates

Built-in payload match templates (game servers and common protocols): used in a rule as match.payload.template; the pattern is compared with a mask starting offset bytes after the start of the payload. The patterns are a starting point: verify them against your server version and monitor in learning mode first

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example PayloadTemplateList
{
  "items": [
    {
      "example_ports": "string",
      "hex": "string",
      "mask": "string",
      "name": "example",
      "note": "string",
      "offset": 0,
      "proto": "string",
      "title": "example"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/payload-templates"

GET/v1/protection/profiles

Protection profiles (static + managed): with the prefixes using them and rule hit counters. The response ETag header is the current protection version.

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example array of ProfileView
[
  {
    "id": 1,
    "name": "example",
    "profile": {
      "ack_validate": null,
      "amplification": null,
      "detection": null,
      "geo": null,
      "id": 1,
      "name": "example",
      "proto_allow": [
        "string"
      ],
      "reputation": {
        "key": "string"
      },
      "reputation_limiter": "string",
      "rules": [],
      "syn_auth": null,
      "tcp_sanity": false
    },
    "rule_hits": [
      {
        "bytes": 0,
        "drop_packets": 0,
        "index": 0,
        "name": "example",
        "packets": 0
      }
    ],
    "source": "string",
    "used_by": [
      {
        "cidr": "203.0.113.0/24",
        "id": 1,
        "mode": "enforce",
        "tenant": "acme"
      }
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/profiles"

POST/v1/protection/profiles

Create a managed profile (ID 128-255 is assigned by the server). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Profile

FieldType
ack_validateAckValidate | null
amplification requiredAmplification | null
detection requiredDetection | null
geoGeo | null
id requiredinteger (int32)
name requiredstring
proto_allow requiredarray of string
reputationmap of string
reputation_limiterstring
rules requiredarray of ConfigRule
syn_auth requiredSynAuth | null
tcp_sanityboolean
{
  "ack_validate": {
    "enabled": false,
    "ttl_s": 0
  },
  "amplification": {
    "action": "string",
    "limiter": "string",
    "min_length": 0,
    "ports": [
      "string"
    ],
    "preset": "string"
  },
  "detection": {
    "approval": null,
    "baseline": null,
    "clear_ticks": 0,
    "thresholds": {
      "key": null
    },
    "trigger_ticks": 0
  },
  "geo": {
    "action": "string",
    "asns": [
      0
    ],
    "countries": [
      "string"
    ],
    "limiter": "string",
    "mode": "enforce"
  },
  "id": 1,
  "name": "example",
  "proto_allow": [
    "string"
  ],
  "reputation": {
    "key": "string"
  },
  "reputation_limiter": "string",
  "rules": [
    {
      "action": "string",
      "limiter": "string",
      "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"
    }
  ],
  "syn_auth": {
    "drop_nonsyn": false,
    "enabled": false,
    "validity_s": 1
  },
  "tcp_sanity": false
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProfileChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "profile": {
    "ack_validate": {
      "enabled": null,
      "ttl_s": null
    },
    "amplification": {
      "action": null,
      "limiter": null,
      "min_length": null,
      "ports": null,
      "preset": null
    },
    "detection": {
      "approval": null,
      "baseline": null,
      "clear_ticks": null,
      "thresholds": null,
      "trigger_ticks": null
    },
    "geo": {
      "action": null,
      "asns": null,
      "countries": null,
      "limiter": null,
      "mode": null
    },
    "id": 1,
    "name": "example",
    "proto_allow": [
      "string"
    ],
    "reputation": {
      "key": "string"
    },
    "reputation_limiter": "string",
    "rules": [
      {
        "action": null,
        "limiter": null,
        "match": null,
        "name": null
      }
    ],
    "syn_auth": {
      "drop_nonsyn": null,
      "enabled": null,
      "validity_s": null
    },
    "tcp_sanity": false
  },
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"ack_validate":{"enabled":false,"ttl_s":0},"amplification":{"action":"string","limiter":"string","min_length":0,"ports":["string"],"preset":"string"},"detection":{"approval":null,"baseline":null,"clear_ticks":0,"thresholds":{"key":null},"trigger_ticks":0},"geo":{"action":"string","asns":[0],"countries":["string"],"limiter":"string","mode":"enforce"},"id":1,"name":"example","proto_allow":["string"],"reputation":{"key":"string"},"reputation_limiter":"string","rules":[{"action":"string","limiter":"string","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"}],"syn_auth":{"drop_nonsyn":false,"enabled":false,"validity_s":1},"tcp_sanity":false}' \
  "https://mssp.example.com:8443/v1/protection/profiles"

GET/v1/protection/profiles/{id}

Profile details. The response ETag header is the current protection version.

permission: protection:readread-only users

Parameters

NameInTypeDescription
id requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Managed state store is disabled
Response example ProfileView
{
  "id": 1,
  "name": "example",
  "profile": {
    "ack_validate": {
      "enabled": null,
      "ttl_s": null
    },
    "amplification": {
      "action": null,
      "limiter": null,
      "min_length": null,
      "ports": null,
      "preset": null
    },
    "detection": {
      "approval": null,
      "baseline": null,
      "clear_ticks": null,
      "thresholds": null,
      "trigger_ticks": null
    },
    "geo": {
      "action": null,
      "asns": null,
      "countries": null,
      "limiter": null,
      "mode": null
    },
    "id": 1,
    "name": "example",
    "proto_allow": [
      "string"
    ],
    "reputation": {
      "key": "string"
    },
    "reputation_limiter": "string",
    "rules": [
      {
        "action": null,
        "limiter": null,
        "match": null,
        "name": null
      }
    ],
    "syn_auth": {
      "drop_nonsyn": null,
      "enabled": null,
      "validity_s": null
    },
    "tcp_sanity": false
  },
  "rule_hits": [
    {
      "bytes": 0,
      "drop_packets": 0,
      "index": 0,
      "name": "example",
      "packets": 0
    }
  ],
  "source": "string",
  "used_by": [
    {
      "cidr": "203.0.113.0/24",
      "id": 1,
      "mode": "enforce",
      "tenant": "acme"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/profiles/{id}"

PUT/v1/protection/profiles/{id}

Fully replace a managed profile (409 for a static profile). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Request body Profile

FieldType
ack_validateAckValidate | null
amplification requiredAmplification | null
detection requiredDetection | null
geoGeo | null
id requiredinteger (int32)
name requiredstring
proto_allow requiredarray of string
reputationmap of string
reputation_limiterstring
rules requiredarray of ConfigRule
syn_auth requiredSynAuth | null
tcp_sanityboolean
{
  "ack_validate": {
    "enabled": false,
    "ttl_s": 0
  },
  "amplification": {
    "action": "string",
    "limiter": "string",
    "min_length": 0,
    "ports": [
      "string"
    ],
    "preset": "string"
  },
  "detection": {
    "approval": null,
    "baseline": null,
    "clear_ticks": 0,
    "thresholds": {
      "key": null
    },
    "trigger_ticks": 0
  },
  "geo": {
    "action": "string",
    "asns": [
      0
    ],
    "countries": [
      "string"
    ],
    "limiter": "string",
    "mode": "enforce"
  },
  "id": 1,
  "name": "example",
  "proto_allow": [
    "string"
  ],
  "reputation": {
    "key": "string"
  },
  "reputation_limiter": "string",
  "rules": [
    {
      "action": "string",
      "limiter": "string",
      "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"
    }
  ],
  "syn_auth": {
    "drop_nonsyn": false,
    "enabled": false,
    "validity_s": 1
  },
  "tcp_sanity": false
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProfileChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "profile": {
    "ack_validate": {
      "enabled": null,
      "ttl_s": null
    },
    "amplification": {
      "action": null,
      "limiter": null,
      "min_length": null,
      "ports": null,
      "preset": null
    },
    "detection": {
      "approval": null,
      "baseline": null,
      "clear_ticks": null,
      "thresholds": null,
      "trigger_ticks": null
    },
    "geo": {
      "action": null,
      "asns": null,
      "countries": null,
      "limiter": null,
      "mode": null
    },
    "id": 1,
    "name": "example",
    "proto_allow": [
      "string"
    ],
    "reputation": {
      "key": "string"
    },
    "reputation_limiter": "string",
    "rules": [
      {
        "action": null,
        "limiter": null,
        "match": null,
        "name": null
      }
    ],
    "syn_auth": {
      "drop_nonsyn": null,
      "enabled": null,
      "validity_s": null
    },
    "tcp_sanity": false
  },
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"ack_validate":{"enabled":false,"ttl_s":0},"amplification":{"action":"string","limiter":"string","min_length":0,"ports":["string"],"preset":"string"},"detection":{"approval":null,"baseline":null,"clear_ticks":0,"thresholds":{"key":null},"trigger_ticks":0},"geo":{"action":"string","asns":[0],"countries":["string"],"limiter":"string","mode":"enforce"},"id":1,"name":"example","proto_allow":["string"],"reputation":{"key":"string"},"reputation_limiter":"string","rules":[{"action":"string","limiter":"string","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"}],"syn_auth":{"drop_nonsyn":false,"enabled":false,"validity_s":1},"tcp_sanity":false}' \
  "https://mssp.example.com:8443/v1/protection/profiles/{id}"

DELETE/v1/protection/profiles/{id}

Delete a managed profile (409 if prefixes use it). If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/profiles/{id}"

GET/v1/protection/revisions

Protection version history (newest first; the last 100 versions are kept)

permission: protection:readread-only users

Parameters

NameInTypeDescription
limitqueryintegerdefault 50, max 100
cursorquerystring`next` from the previous response

Responses

200Success
400Invalid parameter
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Managed state store is disabled
Response example RevisionList
{
  "items": [
    {
      "parent": 0,
      "rev": 0,
      "rollback_of": 0,
      "sha256": "string",
      "summary": "string",
      "time": "2026-10-15T12:00:00Z",
      "user": "string"
    }
  ],
  "next": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/revisions"

GET/v1/protection/revisions/{n}

Version snapshot and diff against the parent version (0: initial)

permission: protection:readread-only users

Parameters

NameInTypeDescription
n requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Version not found or outside retention
429Rate limited
501Managed state store is disabled
Response example RevisionDetail
{
  "diff": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "diff_available": false,
  "parent": 0,
  "protection": {
    "allow": [
      {
        "added": null,
        "by": null,
        "cidr": null,
        "comment": null
      }
    ],
    "deny": [
      {
        "added": null,
        "by": null,
        "cidr": null,
        "comment": null
      }
    ],
    "groups": [
      {
        "description": null,
        "id": null,
        "name": null
      }
    ],
    "limiters": [
      {
        "bps": null,
        "burst_bytes": null,
        "burst_pps": null,
        "name": null,
        "pps": null,
        "scope": null
      }
    ],
    "profiles": [
      {
        "ack_validate": null,
        "amplification": null,
        "detection": null,
        "geo": null,
        "id": null,
        "name": null,
        "proto_allow": null,
        "reputation": null,
        "reputation_limiter": null,
        "rules": null,
        "syn_auth": null,
        "tcp_sanity": null
      }
    ]
  },
  "rev": 0,
  "rollback_of": 0,
  "sha256": "string",
  "summary": "string",
  "time": "2026-10-15T12:00:00Z",
  "user": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/revisions/{n}"

POST/v1/protection/revisions/{n}/rollback

Apply the selected version's content as a NEW version (history is not deleted); it is re-validated against the current configuration. If-Match (ETag "p<n>") is an optional precondition; the response ETag header is the current protection version.

permission: protection:writeaudited

Parameters

NameInTypeDescription
n requiredpathinteger
dry_runquerybooleantrue: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Static record (cannot be changed), already exists or in use (`used_by`)
412If-Match does not match the current version (`current_etag`)
422Invalid configuration (`problems`: line-by-line reasons)
429Rate limited
501Managed state store is disabled
503Audit record could not be written (operation not performed)
Response example ProtChange
{
  "applied": false,
  "changes": [
    {
      "fields": [],
      "key": "string",
      "kind": "string",
      "name": "example",
      "op": "string"
    }
  ],
  "etag": "string",
  "impact": {
    "global": false,
    "live": 0,
    "prefixes": [
      {
        "cidr": null,
        "id": null,
        "live": null,
        "mode": null,
        "tenant": null
      }
    ],
    "total": 0
  },
  "no_change": false,
  "revision": 0,
  "summary": "string",
  "warnings": [
    "string"
  ]
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/revisions/{n}/rollback"

GET/v1/protection/templates

Built-in starter profiles (sample values; must be tuned to your traffic)

permission: protection:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
Response example TemplateList
{
  "items": [
    {
      "description": "string",
      "id": "string",
      "limiters": [],
      "name": "example",
      "profile": {
        "ack_validate": null,
        "amplification": null,
        "detection": null,
        "geo": null,
        "id": null,
        "name": null,
        "proto_allow": null,
        "reputation": null,
        "reputation_limiter": null,
        "rules": null,
        "syn_auth": null,
        "tcp_sanity": null
      }
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/protection/templates"

Mitigation approvals

Mitigations waiting for operator approval.

GET/v1/mitigations

Mitigation requests awaiting an operator decision (on auto prefixes whose profile has detection.approval.required). Staff only; tenants have no access

permission: mitigation:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Approval mechanism is disabled
Response example array of MitigationView
[
  {
    "bps": 0,
    "deadline": "2026-10-15T12:00:00Z",
    "id": "string",
    "on_timeout": "string",
    "pps": 0,
    "prefix": "203.0.113.0/24",
    "prefix_id": 1,
    "remaining_s": 0,
    "since": "2026-10-15T12:00:00Z",
    "tenant": "acme",
    "vector": "udp_flood"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/mitigations"

POST/v1/mitigations/{id}/approve

Approve the mitigation: the prefix is switched to ENFORCE IMMEDIATELY. The decision maker and time are written to the audit chain and the attack record

permission: mitigation:decideaudited

Parameters

NameInTypeDescription
id requiredpathstringattack (incident) ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404No pending approval (already decided, expired, or the attack has ended)
429Rate limited
501Approval mechanism is disabled
503Audit record could not be written (operation not performed)
Response example MitigationDecision
{
  "decision": "string",
  "enforced": false,
  "id": "string",
  "prefix": "203.0.113.0/24"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/mitigations/{id}/approve"

POST/v1/mitigations/{id}/deny

Deny the mitigation: the prefix stays in SENSOR and approval is not requested again for this attack (the attack is NOT mitigated)

permission: mitigation:decideaudited

Parameters

NameInTypeDescription
id requiredpathstringattack (incident) ID

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404No pending approval (already decided, expired, or the attack has ended)
429Rate limited
501Approval mechanism is disabled
503Audit record could not be written (operation not performed)
Response example MitigationDecision
{
  "decision": "string",
  "enforced": false,
  "id": "string",
  "prefix": "203.0.113.0/24"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/mitigations/{id}/deny"

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:readread-only users

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://mssp.example.com:8443/v1/escalations"

POST/v1/escalations

Create an RTBH or FlowSpec entry (admin/operator). RTBH: a single IP (/32, /128) within the tenant's space (authorized BGP prefix or protected prefix); appliance infrastructure addresses (GRE endpoints, internal addresses, BGP next-hop/router) are rejected. FlowSpec: destination prefix ≥ /24 (/48), optional proto, source prefix, source/destination ports, packet length; action discard or rate-limit (bit/s); for a non-host destination at least one additional match is required. Every entry has a duration (default 1 h, max 24 h); submitting the same entry again renews its duration. If tenant is empty, the single tenant covering the prefix is used

permission: escalation:writeaudited

Request body EscalationRequest

FieldType
actionstring
dst_portsstring
kind requiredstring
lengthstring
prefix requiredstring
protostring
rate_bpsinteger (int64)
reasonstring
src_portsstring
src_prefixstring
tenant requiredstring
ttl_sinteger (int64)
{
  "action": "string",
  "dst_ports": "string",
  "kind": "string",
  "length": "string",
  "prefix": "203.0.113.0/24",
  "proto": "string",
  "rate_bps": 0,
  "reason": "string",
  "src_ports": "string",
  "src_prefix": "string",
  "tenant": "acme",
  "ttl_s": 0
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Tenant not found / not within any tenant's space
409Multiple tenant spaces match
422Validation error (reasons in `problems`)
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"action":"string","dst_ports":"string","kind":"string","length":"string","prefix":"203.0.113.0/24","proto":"string","rate_bps":0,"reason":"string","src_ports":"string","src_prefix":"string","tenant":"acme","ttl_s":0}' \
  "https://mssp.example.com:8443/v1/escalations"

GET/v1/escalations/{id}

Single entry

permission: escalation:readread-only users

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://mssp.example.com:8443/v1/escalations/{id}"

DELETE/v1/escalations/{id}

Remove an entry (the announcement is withdrawn). An entry tied to a customer community cannot be deleted

permission: escalation:writeaudited

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
409Customer-originated entry
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
503Audit record could not be written (operation not performed)
Response example map of any
{
  "key": null
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/escalations/{id}"

POST/v1/escalations/{id}/approve

Approve a pending suggestion (source=policy, status=pending): it becomes active and its duration starts at approval time (default 1 h)

permission: escalation:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger

Request body EscalationDecision

FieldType
ttl_sinteger (int64)
{
  "ttl_s": 0
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Entry not found
409Entry is not a pending suggestion
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"ttl_s":0}' \
  "https://mssp.example.com:8443/v1/escalations/{id}/approve"

POST/v1/escalations/{id}/deny

Reject a pending suggestion (the entry is deleted)

permission: escalation:writeaudited

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
429Rate limited
501Upstream entries need BGP to be enabled on this appliance
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://mssp.example.com:8443/v1/escalations/{id}/deny"

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:readread-only users

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://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/tunnels"

POST/v1/tunnels

Create a tunnel (admin/operator). Validation: IPv4 endpoints, unique (local, remote, key), recursive routing (an endpoint cannot be inside a protected prefix), inner address pair in the same subnet, inner subnets do not overlap. A wsg<id> GRE interface is created in the kernel, the inner address is assigned and MSS clamping is added. The ID is assigned automatically

permission: tunnel:writeaudited

Request body Tunnel

FieldType
bgpTunnelBGP | null
commentstring
disabledboolean
id requiredinteger (int32)
inner_localstring
inner_peerstring
keyinteger (int32) | null
local requiredstring
mss_clampboolean | null
mtuinteger (int64)
name requiredstring
no_probeboolean
remote requiredstring
routesarray of string
tenant requiredstring
ttlinteger (int64)
{
  "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,
  "local": "string",
  "mss_clamp": false,
  "mtu": 0,
  "name": "example",
  "no_probe": false,
  "remote": "203.0.113.10",
  "routes": [
    "string"
  ],
  "tenant": "acme",
  "ttl": 0
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Tenant not found
409Conflict
422Validation error (reasons in `problems`)
429Rate limited
501Tunnels are not configured
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"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,"local":"string","mss_clamp":false,"mtu":0,"name":"example","no_probe":false,"remote":"203.0.113.10","routes":["string"],"tenant":"acme","ttl":0}' \
  "https://mssp.example.com:8443/v1/tunnels"

GET/v1/tunnels/{id}

Single tunnel

permission: tunnel:readread-only users

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://mssp.example.com:8443/v1/tunnels/{id}"

PUT/v1/tunnels/{id}

Fully replace a tunnel (ID and tenant do not change). If GRE parameters (local/remote/key/ttl) change, the interface is recreated (brief interruption); MTU, state and inner address change in place

permission: tunnel:writeaudited

Parameters

NameInTypeDescription
id requiredpathinteger

Request body Tunnel

FieldType
bgpTunnelBGP | null
commentstring
disabledboolean
id requiredinteger (int32)
inner_localstring
inner_peerstring
keyinteger (int32) | null
local requiredstring
mss_clampboolean | null
mtuinteger (int64)
name requiredstring
no_probeboolean
remote requiredstring
routesarray of string
tenant requiredstring
ttlinteger (int64)
{
  "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,
  "local": "string",
  "mss_clamp": false,
  "mtu": 0,
  "name": "example",
  "no_probe": false,
  "remote": "203.0.113.10",
  "routes": [
    "string"
  ],
  "tenant": "acme",
  "ttl": 0
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Tunnel not found
409Tenant cannot be changed
422Validation error
429Rate limited
501Tunnels are not configured
503Audit record could not be written (operation not performed)
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 -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"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,"local":"string","mss_clamp":false,"mtu":0,"name":"example","no_probe":false,"remote":"203.0.113.10","routes":["string"],"tenant":"acme","ttl":0}' \
  "https://mssp.example.com:8443/v1/tunnels/{id}"

DELETE/v1/tunnels/{id}

Delete a tunnel (the kernel interface is removed)

permission: tunnel:writeaudited

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
429Rate limited
501Tunnels are not configured
503Audit record could not be written (operation not performed)
Response example map of any
{
  "key": null
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/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:readread-only users

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://mssp.example.com:8443/v1/bgp/prefixes"

POST/v1/bgp/refresh

Re-fetch IRR data now (admin/operator): after a new route object/AS-SET member is added to the registry, without waiting for the automatic refresh (hours). The result triggers re-evaluation

permission: bgp:writeaudited

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409IRR is not configured
429Rate limited
501BGP is not enabled on this appliance
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://mssp.example.com:8443/v1/bgp/refresh"

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:readread-only users

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://mssp.example.com:8443/v1/bgp/sessions"

POST/v1/bgp/sessions/{tunnel}/reset

Reset the tunnel's customer BGP session (admin/operator). That customer's prefixes are withdrawn until the session is re-established

permission: bgp:writeaudited

Parameters

NameInTypeDescription
tunnel requiredpathinteger

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Tunnel or session not found
409Engine could not reset
429Rate limited
501BGP is not enabled on this appliance
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://mssp.example.com:8443/v1/bgp/sessions/{tunnel}/reset"

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:readread-only users

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://mssp.example.com:8443/v1/bgp/status"

GET/v1/system/bgp

Appliance BGP settings (AS, router id, next hop announced to the routers, upstream router sessions such as the MX, RTBH and RPKI/IRR). TCP-MD5 passwords are never returned (only password_set)

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Not available on this installation
Response example BGPSettings
{
  "asn": 0,
  "communities": [
    "string"
  ],
  "customer_communities": {
    "profiles": {
      "key": 0
    },
    "rtbh": "string"
  },
  "enabled": false,
  "irr": {
    "refresh_h": 0,
    "server": "string",
    "sources": "string"
  },
  "listen_port": 0,
  "managed": false,
  "next_hop": "string",
  "next_hop_v6": "string",
  "router_id": "string",
  "routers": [
    {
      "address": "203.0.113.10",
      "asn": 0,
      "clear_password": false,
      "local_address": "string",
      "multihop": false,
      "name": "example",
      "password": "string",
      "password_set": false,
      "ttl_min": 0,
      "ttl_security": false
    }
  ],
  "rpki": {
    "refresh_s": 0,
    "servers": [
      "string"
    ]
  },
  "rtbh_communities": [
    "string"
  ],
  "rtbh_next_hop": "string",
  "rtbh_next_hop_v6": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/bgp"

Reports

Attack and periodic reports (PDF).

GET/v1/report-schedules

Report schedule definitions (with last/next run). ETag = definition version

permission: report:configread-only users

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 ScheduleInfo
[
  {
    "deliver": [
      "string"
    ],
    "enabled": false,
    "id": "string",
    "last_run": "2026-10-15T12:00:00Z",
    "name": "example",
    "next_run": "2026-10-15T12:00:00Z",
    "schedule": {
      "day": 0,
      "hour": 0,
      "kind": "string",
      "tz": "string",
      "weekday": 0
    },
    "sla_target_ms": 0,
    "tenant": "acme",
    "type": "attack.start"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/report-schedules"

POST/v1/report-schedules

Create a scheduled report definition (kind: manual|daily|weekly|monthly; tz, hour, weekday, day). type: incident + kind: attack_end: a report for each attack is generated automatically ~6 min after it ends (if tenant is given, only that customer's attacks). A new definition does not trigger catch-up runs for past due times

permission: report:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body Definition

FieldType
deliverarray of string
enabled requiredboolean
id requiredstring
name requiredstring
schedule requiredSchedule
sla_target_msinteger (int64)
tenantstring
type requiredstring
{
  "deliver": [
    "string"
  ],
  "enabled": false,
  "id": "string",
  "name": "example",
  "schedule": {
    "day": 0,
    "hour": 0,
    "kind": "string",
    "tz": "string",
    "weekday": 0
  },
  "sla_target_ms": 0,
  "tenant": "acme",
  "type": "attack.start"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409Already exists
422Invalid definition (`problems`)
429Rate limited
501Reports are not configured
503Audit record could not be written (operation not performed)
Response example ScheduleChange
{
  "applied": false,
  "definition": {
    "deliver": [
      "string"
    ],
    "enabled": false,
    "id": "string",
    "name": "example",
    "schedule": {
      "day": null,
      "hour": null,
      "kind": null,
      "tz": null,
      "weekday": null
    },
    "sla_target_ms": 0,
    "tenant": "acme",
    "type": "attack.start"
  },
  "rev": 0
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"deliver":["string"],"enabled":false,"id":"string","name":"example","schedule":{"day":0,"hour":0,"kind":"string","tz":"string","weekday":0},"sla_target_ms":0,"tenant":"acme","type":"attack.start"}' \
  "https://mssp.example.com:8443/v1/report-schedules"

GET/v1/report-schedules/{id}

Schedule definition

permission: report:configread-only users

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 ScheduleInfo
{
  "deliver": [
    "string"
  ],
  "enabled": false,
  "id": "string",
  "last_run": "2026-10-15T12:00:00Z",
  "name": "example",
  "next_run": "2026-10-15T12:00:00Z",
  "schedule": {
    "day": 0,
    "hour": 0,
    "kind": "string",
    "tz": "string",
    "weekday": 0
  },
  "sla_target_ms": 0,
  "tenant": "acme",
  "type": "attack.start"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/report-schedules/{id}"

PUT/v1/report-schedules/{id}

Replace a definition

permission: report:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body Definition

FieldType
deliverarray of string
enabled requiredboolean
id requiredstring
name requiredstring
schedule requiredSchedule
sla_target_msinteger (int64)
tenantstring
type requiredstring
{
  "deliver": [
    "string"
  ],
  "enabled": false,
  "id": "string",
  "name": "example",
  "schedule": {
    "day": 0,
    "hour": 0,
    "kind": "string",
    "tz": "string",
    "weekday": 0
  },
  "sla_target_ms": 0,
  "tenant": "acme",
  "type": "attack.start"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
422Invalid definition (`problems`)
429Rate limited
501Reports are not configured
503Audit record could not be written (operation not performed)
Response example ScheduleChange
{
  "applied": false,
  "definition": {
    "deliver": [
      "string"
    ],
    "enabled": false,
    "id": "string",
    "name": "example",
    "schedule": {
      "day": null,
      "hour": null,
      "kind": null,
      "tz": null,
      "weekday": null
    },
    "sla_target_ms": 0,
    "tenant": "acme",
    "type": "attack.start"
  },
  "rev": 0
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"deliver":["string"],"enabled":false,"id":"string","name":"example","schedule":{"day":0,"hour":0,"kind":"string","tz":"string","weekday":0},"sla_target_ms":0,"tenant":"acme","type":"attack.start"}' \
  "https://mssp.example.com:8443/v1/report-schedules/{id}"

DELETE/v1/report-schedules/{id}

Delete a definition (generated reports are kept)

permission: report:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

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
503Audit record could not be written (operation not performed)
Response example ScheduleChange
{
  "applied": false,
  "definition": {
    "deliver": [
      "string"
    ],
    "enabled": false,
    "id": "string",
    "name": "example",
    "schedule": {
      "day": null,
      "hour": null,
      "kind": null,
      "tz": null,
      "weekday": null
    },
    "sla_target_ms": 0,
    "tenant": "acme",
    "type": "attack.start"
  },
  "rev": 0
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/report-schedules/{id}"

POST/v1/report-schedules/{id}/run

Run a definition now (for the last completed period; also sent to delivery channels)

permission: report:writeaudited

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
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/report-schedules/{id}/run"

GET/v1/reports

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

permission: report:readread-only users

Parameters

NameInTypeDescription
typequerystring (monthly_summary | tenant_sla | incident)
tenantquerystringstaff only
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://mssp.example.com:8443/v1/reports"

POST/v1/reports/generate

Generate a report now (monthly_summary | tenant_sla | incident). Period: month | day | from+to; otherwise the previous month. deliver sends the PDF as an attachment to email channels; a report.ready event is published

permission: report:writeaudited

Request body ReportGenerateRequest

FieldType
daystring
deliverarray of string
fromstring
incident_idstring
monthstring
namestring
sla_target_msinteger (int64)
tenantstring
tostring
type requiredstring
tzstring
{
  "day": "string",
  "deliver": [
    "string"
  ],
  "from": "noc@example.com",
  "incident_id": "string",
  "month": "string",
  "name": "example",
  "sla_target_ms": 0,
  "tenant": "acme",
  "to": "noc@example.com",
  "type": "attack.start",
  "tz": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Incident not found
422Invalid request (`problems`)
429Rate limited
501Reports are not configured
503Audit record could not be written (operation not performed)
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 -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"day":"string","deliver":["string"],"from":"noc@example.com","incident_id":"string","month":"string","name":"example","sla_target_ms":0,"tenant":"acme","to":"noc@example.com","type":"attack.start","tz":"string"}' \
  "https://mssp.example.com:8443/v1/reports/generate"

GET/v1/reports/{id}

Report metadata (another tenant's report returns 404)

permission: report:readread-only users

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://mssp.example.com:8443/v1/reports/{id}"

DELETE/v1/reports/{id}

Delete a report

permission: report:writeaudited

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
503Audit record could not be written (operation not performed)
Response example map of boolean
{
  "key": false
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/reports/{id}"

GET/v1/reports/{id}/pdf

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

permission: report:readread-only users

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://mssp.example.com:8443/v1/reports/{id}/pdf"

Integrations

Notification channels (e-mail, webhook, Telegram, syslog, SNMP), rules and delivery history.

GET/v1/notify/channels

Notification channels (no secret fields; secret_set, delivery counters). ETag = configuration version

permission: notify:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Notifications are not configured
Response example array of ChannelView
[
  {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": {
      "dead": 0,
      "dropped": 0,
      "enabled": false,
      "failed": 0,
      "id": "string",
      "last_error": "string",
      "last_error_at": "2026-10-15T12:00:00Z",
      "last_success": "2026-10-15T12:00:00Z",
      "name": "example",
      "queued": 0,
      "sent": 0,
      "suppressed": 0,
      "type": "attack.start"
    },
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/channels"

POST/v1/notify/channels

Create a channel (webhook|syslog|email|telegram|snmp). Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body ChannelInput

FieldType
addressstring
allow_insecureboolean
base_urlstring
ca_filestring
chat_idstring
clear_secretboolean
customer_relayboolean
customer_urlstring
enabled requiredboolean
enterprise_oidstring
facilitystring
formatstring
fromstring
headersmap of string
id requiredstring
languagestring
name requiredstring
panel_urlstring
secretstring
securitystring
subject_prefixstring
tagstring
tenantstring
toarray of string
type requiredstring
urlstring
usernamestring
viastring
{
  "address": "203.0.113.10",
  "allow_insecure": false,
  "base_url": "https://example.com",
  "ca_file": "string",
  "chat_id": "string",
  "clear_secret": false,
  "customer_relay": false,
  "customer_url": "https://example.com",
  "enabled": false,
  "enterprise_oid": "string",
  "facility": "string",
  "format": "string",
  "from": "noc@example.com",
  "headers": {
    "key": "string"
  },
  "id": "string",
  "language": "en",
  "name": "example",
  "panel_url": "https://example.com",
  "secret": "string",
  "security": "string",
  "subject_prefix": "string",
  "tag": "string",
  "tenant": "acme",
  "to": [
    "noc@example.com"
  ],
  "type": "attack.start",
  "url": "https://example.com",
  "username": "string",
  "via": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"address":"203.0.113.10","allow_insecure":false,"base_url":"https://example.com","ca_file":"string","chat_id":"string","clear_secret":false,"customer_relay":false,"customer_url":"https://example.com","enabled":false,"enterprise_oid":"string","facility":"string","format":"string","from":"noc@example.com","headers":{"key":"string"},"id":"string","language":"en","name":"example","panel_url":"https://example.com","secret":"string","security":"string","subject_prefix":"string","tag":"string","tenant":"acme","to":["noc@example.com"],"type":"attack.start","url":"https://example.com","username":"string","via":"string"}' \
  "https://mssp.example.com:8443/v1/notify/channels"

GET/v1/notify/channels/{id}

Channel details

permission: notify:readread-only users

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
501Notifications are not configured
Response example ChannelView
{
  "address": "203.0.113.10",
  "allow_insecure": false,
  "base_url": "https://example.com",
  "ca_file": "string",
  "chat_id": "string",
  "customer_relay": false,
  "customer_url": "https://example.com",
  "enabled": false,
  "enterprise_oid": "string",
  "facility": "string",
  "format": "string",
  "from": "noc@example.com",
  "headers": {
    "key": "string"
  },
  "id": "string",
  "language": "en",
  "name": "example",
  "panel_url": "https://example.com",
  "secret": "string",
  "secret_set": false,
  "security": "string",
  "stats": {
    "dead": 0,
    "dropped": 0,
    "enabled": false,
    "failed": 0,
    "id": "string",
    "last_error": "string",
    "last_error_at": "2026-10-15T12:00:00Z",
    "last_success": "2026-10-15T12:00:00Z",
    "name": "example",
    "queued": 0,
    "sent": 0,
    "suppressed": 0,
    "type": "attack.start"
  },
  "subject_prefix": "string",
  "tag": "string",
  "tenant": "acme",
  "to": [
    "noc@example.com"
  ],
  "type": "attack.start",
  "url": "https://example.com",
  "username": "string",
  "via": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/channels/{id}"

PUT/v1/notify/channels/{id}

Replace a channel; if secret is empty the existing secret is kept, clear_secret deletes it. Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body ChannelInput

FieldType
addressstring
allow_insecureboolean
base_urlstring
ca_filestring
chat_idstring
clear_secretboolean
customer_relayboolean
customer_urlstring
enabled requiredboolean
enterprise_oidstring
facilitystring
formatstring
fromstring
headersmap of string
id requiredstring
languagestring
name requiredstring
panel_urlstring
secretstring
securitystring
subject_prefixstring
tagstring
tenantstring
toarray of string
type requiredstring
urlstring
usernamestring
viastring
{
  "address": "203.0.113.10",
  "allow_insecure": false,
  "base_url": "https://example.com",
  "ca_file": "string",
  "chat_id": "string",
  "clear_secret": false,
  "customer_relay": false,
  "customer_url": "https://example.com",
  "enabled": false,
  "enterprise_oid": "string",
  "facility": "string",
  "format": "string",
  "from": "noc@example.com",
  "headers": {
    "key": "string"
  },
  "id": "string",
  "language": "en",
  "name": "example",
  "panel_url": "https://example.com",
  "secret": "string",
  "security": "string",
  "subject_prefix": "string",
  "tag": "string",
  "tenant": "acme",
  "to": [
    "noc@example.com"
  ],
  "type": "attack.start",
  "url": "https://example.com",
  "username": "string",
  "via": "string"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"address":"203.0.113.10","allow_insecure":false,"base_url":"https://example.com","ca_file":"string","chat_id":"string","clear_secret":false,"customer_relay":false,"customer_url":"https://example.com","enabled":false,"enterprise_oid":"string","facility":"string","format":"string","from":"noc@example.com","headers":{"key":"string"},"id":"string","language":"en","name":"example","panel_url":"https://example.com","secret":"string","security":"string","subject_prefix":"string","tag":"string","tenant":"acme","to":["noc@example.com"],"type":"attack.start","url":"https://example.com","username":"string","via":"string"}' \
  "https://mssp.example.com:8443/v1/notify/channels/{id}"

DELETE/v1/notify/channels/{id}

Delete a channel (409 if rules use it). Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/channels/{id}"

POST/v1/notify/channels/{id}/test

Tests the channel synchronously (sends a test notification); the result is also written to the history

permission: notify:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Channel not found
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyTestResult
{
  "error": "string",
  "ok": false,
  "took_ms": 0
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/channels/{id}/test"

GET/v1/notify/history

Delivery history (newest first): result ok|retry|dead|suppressed|dropped|cooldown|test_ok|test_failed, error (without secrets)

permission: notify:readread-only users

Parameters

NameInTypeDescription
channelquerystringchannel ID
limitqueryintegerdefault 100, max 1000

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Notifications are not configured
Response example array of Delivery
[
  {
    "attempt": 0,
    "channel": "string",
    "error": "string",
    "name": "example",
    "prefix_id": 1,
    "result": "string",
    "tenant": "acme",
    "time": "2026-10-15T12:00:00Z",
    "title": "example",
    "took_ms": 0,
    "type": "attack.start"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/history"

GET/v1/notify/meta

Event types (severity, non-staff visibility), severity levels and channel types

permission: notify:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Notifications are not configured
Response example NotifyMeta
{
  "channel_types": [
    "string"
  ],
  "events": [
    {
      "severity": "string",
      "staff_only": false,
      "type": "attack.start"
    }
  ],
  "severities": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/meta"

GET/v1/notify/rules

Notification rules

permission: notify:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
429Rate limited
501Notifications are not configured
Response example array of NotifyRule
[
  {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/rules"

POST/v1/notify/rules

Create a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body NotifyRule

FieldType
channels requiredarray of string
cooldown_sinteger (int64)
enabled requiredboolean
events requiredarray of string
id requiredstring
min_severitystring
name requiredstring
prefix_idsarray of integer (int32)
tenantstring
vectorsarray of string
{
  "channels": [
    "string"
  ],
  "cooldown_s": 0,
  "enabled": false,
  "events": [
    "attack.start"
  ],
  "id": "string",
  "min_severity": "string",
  "name": "example",
  "prefix_ids": [
    1
  ],
  "tenant": "acme",
  "vectors": [
    "udp_flood"
  ]
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"channels":["string"],"cooldown_s":0,"enabled":false,"events":["attack.start"],"id":"string","min_severity":"string","name":"example","prefix_ids":[1],"tenant":"acme","vectors":["udp_flood"]}' \
  "https://mssp.example.com:8443/v1/notify/rules"

GET/v1/notify/rules/{id}

Rule details

permission: notify:readread-only users

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
501Notifications are not configured
Response example NotifyRule
{
  "channels": [
    "string"
  ],
  "cooldown_s": 0,
  "enabled": false,
  "events": [
    "attack.start"
  ],
  "id": "string",
  "min_severity": "string",
  "name": "example",
  "prefix_ids": [
    1
  ],
  "tenant": "acme",
  "vectors": [
    "udp_flood"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/rules/{id}"

PUT/v1/notify/rules/{id}

Replace a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Request body NotifyRule

FieldType
channels requiredarray of string
cooldown_sinteger (int64)
enabled requiredboolean
events requiredarray of string
id requiredstring
min_severitystring
name requiredstring
prefix_idsarray of integer (int32)
tenantstring
vectorsarray of string
{
  "channels": [
    "string"
  ],
  "cooldown_s": 0,
  "enabled": false,
  "events": [
    "attack.start"
  ],
  "id": "string",
  "min_severity": "string",
  "name": "example",
  "prefix_ids": [
    1
  ],
  "tenant": "acme",
  "vectors": [
    "udp_flood"
  ]
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"channels":["string"],"cooldown_s":0,"enabled":false,"events":["attack.start"],"id":"string","min_severity":"string","name":"example","prefix_ids":[1],"tenant":"acme","vectors":["udp_flood"]}' \
  "https://mssp.example.com:8443/v1/notify/rules/{id}"

DELETE/v1/notify/rules/{id}

Delete a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.

permission: notify:writeaudited

Parameters

NameInTypeDescription
id requiredpathstring
dry_runquerybooleantrue: validate only (nothing is written, no audit record is produced)

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found
409Already exists or in use (`used_by`)
422Invalid configuration (`problems`)
429Rate limited
501Notifications are not configured
503Audit record could not be written (operation not performed)
Response example NotifyChange
{
  "applied": false,
  "channel": {
    "address": "203.0.113.10",
    "allow_insecure": false,
    "base_url": "https://example.com",
    "ca_file": "string",
    "chat_id": "string",
    "customer_relay": false,
    "customer_url": "https://example.com",
    "enabled": false,
    "enterprise_oid": "string",
    "facility": "string",
    "format": "string",
    "from": "noc@example.com",
    "headers": {
      "key": "string"
    },
    "id": "string",
    "language": "en",
    "name": "example",
    "panel_url": "https://example.com",
    "secret": "string",
    "secret_set": false,
    "security": "string",
    "stats": null,
    "subject_prefix": "string",
    "tag": "string",
    "tenant": "acme",
    "to": [
      "noc@example.com"
    ],
    "type": "attack.start",
    "url": "https://example.com",
    "username": "string",
    "via": "string"
  },
  "rev": 0,
  "rule": {
    "channels": [
      "string"
    ],
    "cooldown_s": 0,
    "enabled": false,
    "events": [
      "attack.start"
    ],
    "id": "string",
    "min_severity": "string",
    "name": "example",
    "prefix_ids": [
      1
    ],
    "tenant": "acme",
    "vectors": [
      "udp_flood"
    ]
  }
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/notify/rules/{id}"

Customers & usage

Customers and traffic usage for billing.

GET/v1/tenants

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

permission: tenant:readread-only users

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://mssp.example.com:8443/v1/tenants"

GET/v1/tenants/{id}

Single tenant

permission: tenant:readread-only users

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://mssp.example.com:8443/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://mssp.example.com:8443/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://mssp.example.com:8443/v1/usage"

Users

Portal users of customers.

GET/v1/users

Users (an operator sees only users with tenant roles)

permission: user: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 UserView
[
  {
    "auth": {
      "has_password": false,
      "locked": false,
      "locked_until": "2026-10-15T12:00:00Z",
      "must_change": false,
      "recovery_codes": 0,
      "sessions": 0,
      "tokens": 0,
      "totp": "string"
    },
    "managed": false,
    "name": "example",
    "role": "string",
    "tenant": "acme",
    "uid": 1,
    "unix_user": "string",
    "web": false
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users"

POST/v1/users

Create a user (admin; an operator can create web tenant users only)

permission: user:writeaudited

Request body UserRequest

FieldType
must_change requiredboolean | null
name requiredstring
password requiredstring
role requiredstring
tenant requiredstring
uid requiredinteger (int64) | null
unix_user requiredstring
web requiredboolean
{
  "must_change": false,
  "name": "example",
  "password": "string",
  "role": "string",
  "tenant": "acme",
  "uid": 1,
  "unix_user": "string",
  "web": false
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409Conflict
422Validation rejected
429Rate limited
501Feature is not configured
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"must_change":false,"name":"example","password":"string","role":"string","tenant":"acme","uid":1,"unix_user":"string","web":false}' \
  "https://mssp.example.com:8443/v1/users"

GET/v1/users/{name}

Single user

permission: user:read

Parameters

NameInTypeDescription
name requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
429Rate limited
Response example UserView
{
  "auth": {
    "has_password": false,
    "locked": false,
    "locked_until": "2026-10-15T12:00:00Z",
    "must_change": false,
    "recovery_codes": 0,
    "sessions": 0,
    "tokens": 0,
    "totp": "string"
  },
  "managed": false,
  "name": "example",
  "role": "string",
  "tenant": "acme",
  "uid": 1,
  "unix_user": "string",
  "web": false
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users/{name}"

PATCH/v1/users/{name}

Update a user (role/tenant/web/unix_user; managed records)

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Request body UserPatch

FieldType
role requiredstring | null
tenant requiredstring | null
unix_user requiredstring | null
web requiredboolean | null
{
  "role": "string",
  "tenant": "acme",
  "unix_user": "string",
  "web": false
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
409Static record or your own role
422Validation rejected
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X PATCH -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"role":"string","tenant":"acme","unix_user":"string","web":false}' \
  "https://mssp.example.com:8443/v1/users/{name}"

DELETE/v1/users/{name}

Delete a user (credentials and tokens are also deleted)

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
409Static record or yourself
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users/{name}"

POST/v1/users/{name}/password

Set/reset a password (sessions and tokens are terminated; by default it must be changed at first login)

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Request body SetPasswordRequest

FieldType
must_change requiredboolean | null
password requiredstring
{
  "must_change": false,
  "password": "string"
}

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
422Weak password
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"must_change":false,"password":"string"}' \
  "https://mssp.example.com:8443/v1/users/{name}/password"

DELETE/v1/users/{name}/sessions

Terminate all of the user's sessions

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users/{name}/sessions"

DELETE/v1/users/{name}/totp

Reset 2FA

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X DELETE -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users/{name}/totp"

POST/v1/users/{name}/unlock

Unlock a locked account

permission: user:writeaudited

Parameters

NameInTypeDescription
name requiredpathstring

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Not found (a user you cannot manage also returns 404)
429Rate limited
503Audit record could not be written (operation not performed)
Response example NameStatus
{
  "name": "example",
  "status": "string"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/users/{name}/unlock"

Threat intelligence

Threat intelligence entries and feeds.

GET/v1/ti/entries

Local entries (your own observations); expired ones are not listed

permission: ti:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Threat intelligence is not configured
Response example array of OwnEntry
[
  {
    "added": "2026-10-15T12:00:00Z",
    "by": "string",
    "category": "string",
    "cidr": "203.0.113.0/24",
    "comment": "string",
    "expires": "2026-10-15T12:00:00Z"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ti/entries"

POST/v1/ti/entries

Add a local entry (category own or x6..x15; feed categories cannot be imitated). TTL 60 s..30 days (default 24 hours). There is no automatic blocklisting: with spoofed-source attacks it risks blocking innocent IPs

permission: ti:writeaudited

Request body TIEntryRequest

FieldType
categorystring
cidr requiredstring
commentstring
ttl_sinteger (int64)
{
  "category": "string",
  "cidr": "203.0.113.0/24",
  "comment": "string",
  "ttl_s": 0
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409Entry exists / limit reached
422Invalid CIDR/category/TTL
429Rate limited
501Threat intelligence is not configured
503Audit record could not be written (operation not performed)
Response example OwnEntry
{
  "added": "2026-10-15T12:00:00Z",
  "by": "string",
  "category": "string",
  "cidr": "203.0.113.0/24",
  "comment": "string",
  "expires": "2026-10-15T12:00:00Z"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"category":"string","cidr":"203.0.113.0/24","comment":"string","ttl_s":0}' \
  "https://mssp.example.com:8443/v1/ti/entries"

DELETE/v1/ti/entries

Delete a local entry

permission: ti:writeaudited

Parameters

NameInTypeDescription
cidrquerystring
categoryquerystringdefault own

Responses

200Success
400cidr is missing
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Entry not found
429Rate limited
501Threat intelligence is not configured
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://mssp.example.com:8443/v1/ti/entries"

GET/v1/ti/feeds

URL feeds: operator-defined plain-text IP/CIDR lists (e.g. Spamhaus DROP) and their status (last attempt/success, last error, entry and skipped line counts, next download). Query values in the URL that look secret (key/token/secret…) are masked

permission: ti:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Threat intelligence is not configured
Response example array of URLFeedView
[
  {
    "category": "string",
    "enabled": false,
    "entries": 0,
    "fetching": false,
    "id": "string",
    "interval_s": 0,
    "last_attempt": "2026-10-15T12:00:00Z",
    "last_error": "string",
    "last_success": "2026-10-15T12:00:00Z",
    "name": "example",
    "next_due": "2026-10-15T12:00:00Z",
    "skipped": 0,
    "url": "https://example.com"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ti/feeds"

POST/v1/ti/feeds

Add a URL feed. The list is downloaded with a conditional GET every interval_s seconds (300..604800, default 3600; ≤ 32 MiB, 60 s timeout) and synchronized with category: lines added at the source are added, removed ones are deleted. One IP/CIDR per line; #, ;, // comments are stripped; IPv4 < /8 and IPv6 < /16 are skipped. A failed download (HTTP error, HTML page, limit exceeded) keeps the previous data. At most 32 feeds; 250 000 entries in total across all feeds. The first download runs within 30 s via the scheduler, or with refresh

permission: ti:writeaudited

Request body TIFeedRequest

FieldType
category requiredstring
enabledboolean | null
interval_sinteger (int64)
name requiredstring
url requiredstring
{
  "category": "string",
  "enabled": false,
  "interval_s": 0,
  "name": "example",
  "url": "https://example.com"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
409A feed with the same name exists / feed limit reached
422Invalid name/URL/category/interval
429Rate limited
501Threat intelligence is not configured
503Audit record could not be written (operation not performed)
Response example URLFeedView
{
  "category": "string",
  "enabled": false,
  "entries": 0,
  "fetching": false,
  "id": "string",
  "interval_s": 0,
  "last_attempt": "2026-10-15T12:00:00Z",
  "last_error": "string",
  "last_success": "2026-10-15T12:00:00Z",
  "name": "example",
  "next_due": "2026-10-15T12:00:00Z",
  "skipped": 0,
  "url": "https://example.com"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"category":"string","enabled":false,"interval_s":0,"name":"example","url":"https://example.com"}' \
  "https://mssp.example.com:8443/v1/ti/feeds"

PUT/v1/ti/feeds/{id}

Update a URL feed (omitted fields are unchanged). Category and enabled changes are applied to the kernel immediately; a disabled feed's data is kept but not applied. When the URL changes the feed is re-downloaded immediately (the old data is kept until the new data arrives)

permission: ti:writeaudited

Parameters

NameInTypeDescription
id requiredpathstringURL feed ID (uf-…)

Request body URLFeedPatch

FieldType
categorystring | null
enabledboolean | null
interval_sinteger (int64) | null
namestring | null
urlstring | null
{
  "category": "string",
  "enabled": false,
  "interval_s": 0,
  "name": "example",
  "url": "https://example.com"
}

Responses

200Success
400Invalid request
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Feed not found
409A feed with the same name exists / enabling would exceed the total limit
422Invalid name/URL/category/interval
429Rate limited
501Threat intelligence is not configured
503Audit record could not be written (operation not performed)
Response example URLFeedView
{
  "category": "string",
  "enabled": false,
  "entries": 0,
  "fetching": false,
  "id": "string",
  "interval_s": 0,
  "last_attempt": "2026-10-15T12:00:00Z",
  "last_error": "string",
  "last_success": "2026-10-15T12:00:00Z",
  "name": "example",
  "next_due": "2026-10-15T12:00:00Z",
  "skipped": 0,
  "url": "https://example.com"
}
curl -X PUT -H "Authorization: Bearer $WS_TOKEN" \
  -H "Content-Type: application/json" -d '{"category":"string","enabled":false,"interval_s":0,"name":"example","url":"https://example.com"}' \
  "https://mssp.example.com:8443/v1/ti/feeds/{id}"

DELETE/v1/ti/feeds/{id}

Delete a URL feed: its entries are removed from the kernel and its data is deleted

permission: ti:writeaudited

Parameters

NameInTypeDescription
id requiredpathstringURL feed ID (uf-…)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Feed not found
429Rate limited
501Threat intelligence is not configured
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://mssp.example.com:8443/v1/ti/feeds/{id}"

POST/v1/ti/feeds/{id}/refresh

Download and apply a URL feed now. The response waits at most 12 s; if the download takes longer it completes in the background and a view with fetching: true is returned

permission: ti:writeaudited

Parameters

NameInTypeDescription
id requiredpathstringURL feed ID (uf-…)

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
404Feed not found
409This feed is already downloading / total entry limit
429Rate limited
501Threat intelligence is not configured
502Download or parsing failed (previous data kept)
503Audit record could not be written (operation not performed)
Response example URLFeedView
{
  "category": "string",
  "enabled": false,
  "entries": 0,
  "fetching": false,
  "id": "string",
  "interval_s": 0,
  "last_attempt": "2026-10-15T12:00:00Z",
  "last_error": "string",
  "last_success": "2026-10-15T12:00:00Z",
  "name": "example",
  "next_due": "2026-10-15T12:00:00Z",
  "skipped": 0,
  "url": "https://example.com"
}
curl -X POST -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ti/feeds/{id}/refresh"

GET/v1/ti/lookup

Which categories/entries an IP matches (feed and local; most specific to most general)

permission: ti:readread-only users

Parameters

NameInTypeDescription
ipquerystring

Responses

200Success
400Invalid IP
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Threat intelligence is not configured
Response example TILookupView
{
  "ip": "203.0.113.10",
  "matches": [
    {
      "category": "string",
      "comment": "string",
      "expires": "2026-10-15T12:00:00Z",
      "prefix": "203.0.113.0/24",
      "source": "string"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ti/lookup"

GET/v1/ti/status

Threat intelligence status: feed name/version/age (stale: older than 72 hours), entry counts per category, local entry count, effective entry count written to the kernel, rejected packets and matched traffic per category

permission: ti:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Threat intelligence is not configured
Response example TIStatusView
{
  "age_s": 0,
  "applied_at": "2026-10-15T12:00:00Z",
  "created": "2026-10-15T12:00:00Z",
  "effective": 0,
  "entries": {
    "key": 0
  },
  "feed": "string",
  "key_id": "string",
  "last_reject": "string",
  "own": 0,
  "rejected": 0,
  "seq": 0,
  "stale": false,
  "traffic": [
    {
      "category": "string",
      "stats": {
        "bytes": null,
        "drop_bytes": null,
        "drop_packets": null,
        "packets": null,
        "wd_bytes": null,
        "wd_packets": null
      }
    }
  ],
  "trusted_keys": 0,
  "url_feed_entries": 0,
  "url_feeds": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/ti/status"

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:readread-only users

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://mssp.example.com:8443/v1/geo/asn-names"

GET/v1/geo/lookup

Country and ASN of an IP (longest matching record; known:false if not in the database — such a source matches no country/ASN policy or rule)

permission: geo:readread-only users

Parameters

NameInTypeDescription
ipquerystring

Responses

200Success
400Invalid IP
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501GeoIP is not configured
Response example GeoLookupView
{
  "asn": 0,
  "country": "string",
  "ip": "203.0.113.10",
  "known": false
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/geo/lookup"

GET/v1/geo/status

GeoIP/ASN database status: record counts (v4/v6), distinct country/ASN counts, source name, content SHA-256, import time/user and data plane counters (lookups, sources not in the database, policy matches)

permission: geo:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501GeoIP is not configured
Response example GeoStatusView
{
  "asns": 0,
  "bytes": 0,
  "countries": 0,
  "imported_at": "2026-10-15T12:00:00Z",
  "imported_by": "string",
  "kernel": {
    "hit": {
      "bytes": null,
      "drop_bytes": null,
      "drop_packets": null,
      "packets": null,
      "wd_bytes": null,
      "wd_packets": null
    },
    "lookups": 0,
    "unknown": 0
  },
  "loaded": false,
  "seq": 0,
  "sha256": "string",
  "signer": "string",
  "source": "string",
  "v4": 0,
  "v6": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/geo/status"

GET/v1/geo/update

MaxMind GeoLite automatic update status: whether configured, account ID, whether a key is set (the key itself is NEVER returned), interval, last attempt/success/error, next run time, applied version

permission: geo:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Automatic update is not configured
Response example UpdateStatus
{
  "account_id": "string",
  "configured": false,
  "enabled": false,
  "failures": 0,
  "interval_h": 0,
  "key_set": false,
  "last_attempt": "2026-10-15T12:00:00Z",
  "last_error": "string",
  "last_success": "2026-10-15T12:00:00Z",
  "next": "2026-10-15T12:00:00Z",
  "running": false,
  "version": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/geo/update"

Appliance self-protection

Protection of the appliance's own addresses.

GET/v1/selfprot

Appliance self-protection: mode (off | dry-run | enforce), time-limited enforce awaiting confirmation (pending_confirm_s, expired), protected appliance addresses, ordered allow rules (implicit ones are implicit: tunnel endpoints, BGP routers, management ports, return traffic) and match counters, verdict counters (stats: seen, rule_ok, icmp_ok, nomatch, rate, icmp_bad, icmp_rate; drop_* dropped in enforce, wd_* would be dropped in dry-run)

permission: selfprot:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Self-protection is not available (no data plane)
Response example SelfProtStatus
{
  "addresses": [
    "string"
  ],
  "configured": false,
  "expired": false,
  "icmp_echo_limited": false,
  "mode": "enforce",
  "pending_by": "string",
  "pending_confirm_s": 0,
  "rules": [
    {
      "bytes": 0,
      "implicit": false,
      "name": "example",
      "packets": 0,
      "slot": 0
    }
  ],
  "source_set_entries": 0,
  "stats": {
    "key": {
      "bytes": 0,
      "drop_bytes": 0,
      "drop_packets": 0,
      "packets": 0,
      "wd_bytes": 0,
      "wd_packets": 0
    }
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/selfprot"

GET/v1/selfprot/seen

Totals of traffic matching no rule by {proto, family, port/ICMP type}, most packets first. Used to write rules during dry-run; suggested_rule is a sample rule that would allow this traffic (none for ICMP: errors/ND are built in)

permission: selfprot:readread-only users

Parameters

NameInTypeDescription
limitqueryintegermaximum entries (1-1000), default 100

Responses

200Success
400Invalid limit
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Self-protection is not available (no data plane)
Response example array of SelfProtSeenView
[
  {
    "bytes": 0,
    "family": 0,
    "packets": 0,
    "port": 0,
    "proto": 0,
    "proto_name": "string",
    "suggested_rule": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/selfprot/seen"

System

Appliance health, interfaces, license and metrics.

GET/metrics

Prometheus metrics (text format 0.0.4); not available to the tenant role. Authentication: Bearer token (read-only recommended)

permission: metrics:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
500Data plane counters could not be read (Prometheus sees up=0)
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/metrics"

GET/v1/health

Health

read-only users

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://mssp.example.com:8443/v1/health"

GET/v1/license

License status: state (none|not_yet|valid|grace|expired), customer/edition/features/limits, days remaining, grace period end, appliance ID (machine_id; give it to the vendor to bind the license to this appliance). 501 if license management is disabled. PROTECTION NEVER stops because of the license: the license only limits adding NEW features/resources

permission: license:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501License management is disabled
Response example LicenseStatus
{
  "days_left": 0,
  "enforced": false,
  "evaluation": false,
  "grace_ends": "2026-10-15T12:00:00Z",
  "license": {
    "appliance": "string",
    "customer": "string",
    "edition": "string",
    "expires": "2026-10-15T12:00:00Z",
    "features": [
      "string"
    ],
    "format": 0,
    "id": "string",
    "issued": "2026-10-15T12:00:00Z",
    "limits": {
      "max_gbps": null,
      "max_prefixes": null,
      "max_tenants": null,
      "max_tunnels": null
    },
    "not_before": "2026-10-15T12:00:00Z"
  },
  "machine_id": "string",
  "reason": "string",
  "state": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/license"

GET/v1/system/certificate

Certificate served to the web panel (management and local customer portal listeners): source ("" internal/self-signed | upload | acme), names, issuer, expiry, fingerprint; Let's Encrypt settings (the Cloudflare token only as token_set), last attempt and error, available validation methods. The internal certificate pinned by the portal server is NOT changed by this endpoint

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Certificate management is disabled
Response example CertmgrStatus
{
  "acme": {
    "domains": [
      "string"
    ],
    "email": "noc@example.com",
    "method": "string",
    "staging": false,
    "token_set": false
  },
  "cert": {
    "dns_names": [
      "string"
    ],
    "fingerprint": "string",
    "ips": [
      "203.0.113.10"
    ],
    "issuer": "string",
    "not_after": "2026-10-15T12:00:00Z",
    "not_before": "2026-10-15T12:00:00Z",
    "self_signed": false,
    "subject": "string"
  },
  "last_attempt": "2026-10-15T12:00:00Z",
  "last_error": "string",
  "last_success": "2026-10-15T12:00:00Z",
  "methods": [
    "string"
  ],
  "running": false,
  "source": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/certificate"

GET/v1/system/health

System health: host (CPU cores, memory, disk, temperature), the service, telemetry, audit chain, TLS

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501System information is not configured
Response example SystemHealthResponse
{
  "audit": {
    "bytes": 0,
    "enabled": false,
    "last_hash": "string",
    "records": 0,
    "segments": 0
  },
  "host": {
    "bmc": "string",
    "cores": [
      {
        "id": null,
        "used_pct": null
      }
    ],
    "cpus": [
      {
        "cores": null,
        "cpu_ids": null,
        "id": null,
        "model": null,
        "temp_c": null,
        "threads": null
      }
    ],
    "disk_free": 0,
    "disk_total": 0,
    "fans": [
      {
        "name": null,
        "pct": null,
        "rpm": null,
        "status": null
      }
    ],
    "hostname": "string",
    "hw": {
      "bios": "string",
      "board": "string",
      "cpu_count": 0,
      "cpu_model": "string",
      "product": "string",
      "serial": "string",
      "vendor": "string",
      "virtual": false
    },
    "kernel": "string",
    "load1": 0,
    "load15": 0,
    "load5": 0,
    "mem_available": 0,
    "mem_total": 0,
    "os_version": "string",
    "power_w": 0,
    "psus": [
      {
        "name": null,
        "status": null,
        "watts": null
      }
    ],
    "temps": [
      {
        "celsius": null,
        "sensor": null,
        "status": null
      }
    ],
    "uptime_s": 0
  },
  "telemetry": {
    "adaptive_adjustments": 0,
    "adaptive_enabled": false,
    "adaptive_max_rate": 0,
    "adaptive_min_rate": 0,
    "adaptive_target_samples_per_sec": 0,
    "decode_errors": 0,
    "disk_bytes": 0,
    "disk_enabled": false,
    "disk_errors": 0,
    "disk_segments": 0,
    "kernel_sample_lost": 0,
    "kernel_sampled": 0,
    "prefix_states": 0,
    "read_errors": 0,
    "sample_rate": 0,
    "samples_processed": 0,
    "samples_rejected": 0
  },
  "tls": {
    "dns_names": [
      "string"
    ],
    "expired": false,
    "fingerprint": "string",
    "ips": [
      "203.0.113.10"
    ],
    "not_after": "2026-10-15T12:00:00Z",
    "not_before": "2026-10-15T12:00:00Z",
    "self_signed": false,
    "subject": "string"
  },
  "wsd": {
    "interface": "string",
    "started": "2026-10-15T12:00:00Z",
    "uptime_s": 0,
    "version": "string",
    "xdp_mode": "string"
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/health"

GET/v1/system/history

CPU/memory/temperature history for the last hour (10 s interval, kept in the service memory; reset on restart)

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501System information is not configured
Response example SystemHistory
{
  "points": [
    {
      "cpu_pct": 0,
      "mem_pct": 0,
      "t": 0,
      "temp_c": 0
    }
  ],
  "step_secs": 0,
  "window_secs": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/history"

GET/v1/system/interfaces

Network interfaces: link state/speed, driver, queue count, error and drop counters, XDP mode

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501System information is not configured
Response example array of NetworkInterface
[
  {
    "driver": "string",
    "mac": "string",
    "mtu": 0,
    "name": "example",
    "queues": 0,
    "role": "string",
    "rx_bytes": 0,
    "rx_dropped": 0,
    "rx_errors": 0,
    "rx_packets": 0,
    "speed_mbps": 0,
    "state": "string",
    "tx_bytes": 0,
    "tx_dropped": 0,
    "tx_errors": 0,
    "tx_packets": 0,
    "xdp_mode": "string"
  }
]
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/interfaces"

GET/v1/system/portal

Connection of the separate portal server: listener ports, allowed portal server addresses and client certificate fingerprints, and this appliance's certificate fingerprint for pinning

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Not available on this installation
Response example PortalView
{
  "appliance_fp": "string",
  "client_fps": [
    "string"
  ],
  "customer_port": 0,
  "last_error": "string",
  "listening": {
    "customer": false,
    "mssp": false
  },
  "managed": false,
  "mssp_port": 0,
  "servers": [
    "string"
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/portal"

GET/v1/system/routed

Routed (L3) inline mode: data port addresses (MX204 / QFX side), QFX next-hop, return path and live state (links, next-hop ARP, installed prefix routes)

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Mode is not available
Response example RoutedView
{
  "config": {
    "bfd": {
      "enabled": null,
      "interval_ms": null,
      "multiplier": null
    },
    "downstream": {
      "address": "203.0.113.10",
      "extra_addresses": [],
      "interface": "string"
    },
    "enabled": false,
    "forward_unprotected": false,
    "maintenance": false,
    "next_hop": "string",
    "return_via_upstream": false,
    "upstream": {
      "address": "203.0.113.10",
      "extra_addresses": [],
      "interface": "string"
    },
    "upstream_peer": "string"
  },
  "status": {
    "downstream_up": false,
    "enabled": false,
    "forward_unprotected": false,
    "last_error": "string",
    "next_hop_ok": false,
    "prefixes": [
      "string"
    ],
    "return_path": false,
    "routes": 0,
    "updated": "2026-10-15T12:00:00Z",
    "upstream_up": false
  }
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/routed"

GET/v1/system/routed/bfd

BFD and maintenance status of routed inline mode: sessions with the upstream router and the downstream switch, health gate and maintenance mode

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Not available on this installation
Response example BFDView
{
  "downstream_address": "string",
  "enabled": false,
  "health_reason": "string",
  "healthy": false,
  "interval_ms": 0,
  "maintenance": false,
  "multiplier": 0,
  "next_hop": "string",
  "peers": [
    {
      "diag": "string",
      "error": "string",
      "interval_ms": 0,
      "local": "string",
      "multiplier": 0,
      "name": "example",
      "peer": "203.0.113.10",
      "remote_state": "string",
      "sending": false,
      "since": "2026-10-15T12:00:00Z",
      "state": "string"
    }
  ],
  "upstream_address": "string",
  "upstream_peer": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/routed/bfd"

GET/v1/system/session

Web session timeouts (idle and maximum length) for all web users

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Not available on this installation
Response example SessionSettings
{
  "idle_minutes": 1,
  "max_hours": 0
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/session"

GET/v1/system/tls

TLS certificate summary (fingerprint, validity)

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501No TLS listener
Response example TlsutilCertInfo
{
  "dns_names": [
    "string"
  ],
  "expired": false,
  "fingerprint": "string",
  "ips": [
    "203.0.113.10"
  ],
  "not_after": "2026-10-15T12:00:00Z",
  "not_before": "2026-10-15T12:00:00Z",
  "self_signed": false,
  "subject": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/tls"

GET/v1/system/updates

Application releases: active/previous version, activation awaiting confirmation, installed versions, recent events, rolled-back versions. READ-ONLY: install/activate/rollback from the console

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Update repository is not configured
Response example UpdateView
{
  "current": "string",
  "failed": {
    "key": "string"
  },
  "history": [
    {
      "at": "2026-10-15T12:00:00Z",
      "kind": "string",
      "note": "string",
      "version": "string"
    }
  ],
  "pending": {
    "boots": 0,
    "deadline": "2026-10-15T12:00:00Z",
    "from": "noc@example.com",
    "since": "2026-10-15T12:00:00Z",
    "version": "string"
  },
  "previous": "string",
  "releases": [
    {
      "created": "2026-10-15T12:00:00Z",
      "current": false,
      "notes": "string",
      "version": "string"
    }
  ]
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/updates"

GET/v1/system/updates/job

Status of the last panel update: running | succeeded | failed, package digest (SHA-256), tail of the installer output, whether a reboot is required

permission: system:readread-only users

Responses

200Success
401Authentication required
403Forbidden: missing permission, another customer's resource, or a read-only token used for a change
429Rate limited
501Panel updates are not configured
503Helper service is not responding
Response example Job
{
  "file": "string",
  "finished": "2026-10-15T12:00:00Z",
  "id": "string",
  "kind": "string",
  "output": "string",
  "reboot": false,
  "sha256": "string",
  "size": 0,
  "started": "2026-10-15T12:00:00Z",
  "state": "string"
}
curl -H "Authorization: Bearer $WS_TOKEN" \
  "https://mssp.example.com:8443/v1/system/updates/job"

Schemas

ACMEView

domains requiredarray of string
emailstring
method requiredstring
stagingboolean
token_set requiredboolean

ASNNamesResponse

names requiredmap of string

AckInfo

Known4 requiredinteger (int64)
Known6 requiredinteger (int64)
Pending4 requiredinteger (int64)
Pending6 requiredinteger (int64)
Total4 requiredinteger (int64)
Total6 requiredinteger (int64)

AckValidate

enabled requiredboolean
ttl_s requiredinteger (int64)

Amplification

action requiredstring
limiter requiredstring
min_length requiredinteger (int64)
ports requiredarray of string
preset requiredstring

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)

AuditInfo

bytes requiredinteger (int64)
enabled requiredboolean
last_hash requiredstring
records requiredinteger (int64)
segments requiredinteger (int64)

AuthStatus

has_password requiredboolean
locked requiredboolean
locked_untilstring (date-time)
must_change requiredboolean
recovery_codes requiredinteger (int64)
sessions requiredinteger (int64)
tokens requiredinteger (int64)
totp requiredstring

BFD

enabled requiredboolean
interval_msinteger (int64)
multiplierinteger (int64)

BFDView

downstream_addressstring
enabled requiredboolean
health_reasonstring
healthy requiredboolean
interval_ms requiredinteger (int64)
maintenance requiredboolean
multiplier requiredinteger (int64)
next_hopstring
peers requiredarray of PeerStatus
upstream_addressstring
upstream_peerstring

BGPCustomers

profilesmap of integer (int32)
rtbhstring

BGPIRR

refresh_hinteger (int64)
server requiredstring
sourcesstring

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

BGPRPKI

refresh_sinteger (int64)
servers requiredarray of string

BGPRPKIView

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

BGPRouterSetting

address requiredstring
asninteger (int32)
clear_passwordboolean
local_addressstring
multihopboolean
name requiredstring
passwordstring
password_set requiredboolean
ttl_mininteger (int64)
ttl_securityboolean

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)

BGPSettings

asn requiredinteger (int32)
communities requiredarray of string
customer_communitiesBGPCustomers | null
enabled requiredboolean
irrBGPIRR | null
listen_portinteger (int64)
managed requiredboolean
next_hop requiredstring
next_hop_v6string
router_id requiredstring
routers requiredarray of BGPRouterSetting
rpkiBGPRPKI | null
rtbh_communitiesarray of string
rtbh_next_hopstring
rtbh_next_hop_v6string

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)

Baseline

alpha requirednumber
factor requirednumber
min_bps requirednumber
min_pps requirednumber
warmup_ticks requiredinteger (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

CaptureList

items requiredarray of PcapMeta

CaptureRequest

duration_s requiredinteger (int64)
filter requiredFilterSpec
max_pps requiredinteger (int64)
prefix_id requiredinteger (int32)
snaplen requiredinteger (int64)
verdicts requiredarray of string

CertmgrCertInfo

dns_names requiredarray of string
fingerprint requiredstring
ips requiredarray of string
issuer requiredstring
not_after requiredstring (date-time)
not_before requiredstring (date-time)
self_signed requiredboolean
subject requiredstring

CertmgrStatus

acmeACMEView | null
certCertmgrCertInfo | null
last_attemptstring (date-time) | null
last_errorstring
last_successstring (date-time) | null
methods requiredarray of string
running requiredboolean
source requiredstring

Change

fields requiredarray of FieldChange
key requiredstring
kind requiredstring
namestring
op requiredstring

ChannelInput

addressstring
allow_insecureboolean
base_urlstring
ca_filestring
chat_idstring
clear_secretboolean
customer_relayboolean
customer_urlstring
enabled requiredboolean
enterprise_oidstring
facilitystring
formatstring
fromstring
headersmap of string
id requiredstring
languagestring
name requiredstring
panel_urlstring
secretstring
securitystring
subject_prefixstring
tagstring
tenantstring
toarray of string
type requiredstring
urlstring
usernamestring
viastring

ChannelStats

dead requiredinteger (int64)
dropped requiredinteger (int64)
enabled requiredboolean
failed requiredinteger (int64)
id requiredstring
last_errorstring
last_error_atstring (date-time)
last_successstring (date-time)
name requiredstring
queued requiredinteger (int64)
sent requiredinteger (int64)
suppressed requiredinteger (int64)
type requiredstring

ChannelView

addressstring
allow_insecureboolean
base_urlstring
ca_filestring
chat_idstring
customer_relayboolean
customer_urlstring
enabled requiredboolean
enterprise_oidstring
facilitystring
formatstring
fromstring
headersmap of string
id requiredstring
languagestring
name requiredstring
panel_urlstring
secretstring
secret_set requiredboolean
securitystring
statsChannelStats | null
subject_prefixstring
tagstring
tenantstring
toarray of string
type requiredstring
urlstring
usernamestring
viastring

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

Collector

active_timeout_sinteger (int64)
address requiredstring
agent_addressstring
enabled requiredboolean
id requiredstring
if_indexinteger (int32)
observation_domaininteger (int32)
prefix_idsarray of integer (int32)
sub_agent_idinteger (int32)
template_refresh_sinteger (int64)
transportstring
type requiredstring
verdictsarray of string

ConfigApproval

on_timeoutstring
required requiredboolean
timeout_sinteger (int64)

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

ConfigRule

action requiredstring
limiter requiredstring
match requiredConfigMatch
name requiredstring

ConfigThreshold

bps requirednumber
pps requirednumber

CountPair

managed requiredinteger (int64)
static requiredinteger (int64)

Counters

global requiredarray of NamedStats
reasons requiredarray of NamedStats

CpuCore

id requiredinteger (int64)
used_pct requirednumber

CpuPackage

cores requiredinteger (int64)
cpu_ids requiredarray of integer (int64)
id requiredinteger (int64)
model requiredstring
temp_c requirednumber
threads requiredinteger (int64)

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

Definition

deliverarray of string
enabled requiredboolean
id requiredstring
name requiredstring
schedule requiredSchedule
sla_target_msinteger (int64)
tenantstring
type requiredstring

Delivery

attemptinteger (int64)
channel requiredstring
errorstring
name requiredstring
prefix_idinteger (int32)
result requiredstring
tenantstring
time requiredstring (date-time)
title requiredstring
took_msinteger (int64)
type requiredstring

Detection

approvalConfigApproval | null
baseline requiredBaseline | null
clear_ticks requiredinteger (int64)
thresholds requiredmap of ConfigThreshold
trigger_ticks requiredinteger (int64)

DimSeriesPoint

other requirednumber
t requiredinteger (int64)
values requiredarray of number

DimSeriesResponse

dim requiredstring
keys requiredarray of string
metric requiredstring
points requiredarray of DimSeriesPoint
res requiredstring

EscalationDecision

ttl_sinteger (int64)

EscalationRequest

actionstring
dst_portsstring
kind requiredstring
lengthstring
prefix requiredstring
protostring
rate_bpsinteger (int64)
reasonstring
src_portsstring
src_prefixstring
tenant requiredstring
ttl_sinteger (int64)

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

Event

at requiredstring (date-time)
kind requiredstring
notestring
version requiredstring

EventMeta

severity requiredstring
staff_only requiredboolean
type requiredstring

ExportConfig

collectors requiredarray of Collector

ExportStatus

active_flowsinteger (int64)
bytes requiredinteger (int64)
collector requiredCollector
errors requiredinteger (int64)
last_errorstring
last_sendstring (date-time) | null
messages requiredinteger (int64)
queue_drops requiredinteger (int64)
records requiredinteger (int64)
samples requiredinteger (int64)

ExportView

collectors requiredarray of ExportStatus
config requiredExportConfig

Fan

name requiredstring
pctnumber
rpm requiredinteger (int64)
statusstring

FieldChange

new requiredany
old requiredany
path requiredstring

FilterSpec

dportinteger (int64)
dststring
protostring
sportinteger (int64)
srcstring

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

Geo

action requiredstring
asnsarray of integer (int32)
countriesarray of string
limiterstring
mode requiredstring

GeoLookupView

asninteger (int32)
countrystring
ip requiredstring
known requiredboolean

GeoStats

hit requiredStats
lookups requiredinteger (int64)
unknown requiredinteger (int64)

GeoStatusView

asns requiredinteger (int64)
bytes requiredinteger (int64)
countries requiredinteger (int64)
imported_at requiredstring (date-time)
imported_bystring
kernelGeoStats | null
loaded requiredboolean
seqinteger (int64)
sha256 requiredstring
signerstring
source requiredstring
v4 requiredinteger (int64)
v6 requiredinteger (int64)

Group

descriptionstring
id requiredinteger (int32)
name requiredstring

GroupChange

applied requiredboolean
changes requiredarray of Change
etag requiredstring
group requiredGroup
impact requiredImpact
no_change requiredboolean
revision requiredinteger (int64)
summary requiredstring
warnings requiredarray of string

GroupView

active_attacks requiredinteger (int64)
descriptionstring
id requiredinteger (int32)
modes requiredmap of integer (int64)
name requiredstring
prefixes requiredinteger (int64)
source requiredstring
tenants requiredarray of string

Hardware

bios requiredstring
board requiredstring
cpu_count requiredinteger (int64)
cpu_model requiredstring
product requiredstring
serial requiredstring
vendor requiredstring
virtual 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

HistPoint

cpu_pct requirednumber
mem_pct requirednumber
t requiredinteger (int64)
temp_c requirednumber

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

Impact

global requiredboolean
live requiredinteger (int64)
prefixes requiredarray of PrefixImpact
total requiredinteger (int64)

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

Job

filestring
finishedstring (date-time)
idstring
kindstring
outputstring
rebootboolean
sha256string
sizeinteger (int64)
startedstring (date-time)
state requiredstring

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

License

appliance requiredstring
customer requiredstring
edition requiredstring
expires requiredstring (date-time)
features requiredarray of string
format requiredinteger (int64)
id requiredstring
issued requiredstring (date-time)
limits requiredLimits
not_before requiredstring (date-time)

LicenseStatus

days_left requiredinteger (int64)
enforced requiredboolean
evaluation requiredboolean
grace_endsstring (date-time) | null
licenseLicense | null
machine_id requiredstring
reasonstring
state requiredstring

Limiter

bps requirednumber
burst_bytes requiredinteger (int64)
burst_pps requiredinteger (int64)
name requiredstring
pps requirednumber
scope requiredstring

LimiterChange

applied requiredboolean
changes requiredarray of Change
etag requiredstring
impact requiredImpact
limiter requiredLimiter
no_change requiredboolean
revision requiredinteger (int64)
summary requiredstring
warnings requiredarray of string

LimiterInfo

bps requirednumber
buckets requiredinteger (int64)
burst_bytes requiredinteger (int64)
burst_pkts requiredinteger (int64)
id requiredinteger (int32)
pps requirednumber
scope requiredstring

LimiterView

id requiredinteger (int32)
limiter requiredLimiter
name requiredstring
source requiredstring
used_by requiredarray of string

Limits

max_gbps requiredinteger (int64)
max_prefixes requiredinteger (int64)
max_tenants requiredinteger (int64)
max_tunnels requiredinteger (int64)

LinkRow

configured requiredLink
last_errorstring
name requiredstring
role requiredstring
state requiredState

ListEntry

added requiredstring (date-time)
bystring
cidr requiredstring
commentstring

ListEntryRequest

cidr requiredstring
comment requiredstring

ListItem

addedstring (date-time)
bystring
cidr requiredstring
commentstring
source requiredstring

Lists

allow requiredarray of string
deny requiredarray of string

ListsView

allow requiredarray of ListItem
deny requiredarray of ListItem

MitigationDecision

decision requiredstring
enforced requiredboolean
id requiredstring
prefix requiredstring

MitigationView

bps requirednumber
deadline requiredstring (date-time)
id requiredstring
on_timeout requiredstring
pps requirednumber
prefix requiredstring
prefix_id requiredinteger (int32)
remaining_s requirednumber
since requiredstring (date-time)
tenantstring
vector requiredstring

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)

NameStatus

name requiredstring
status requiredstring

NamedStats

name requiredstring
stats requiredStats

NetworkInterface

driver requiredstring
mac requiredstring
mtu requiredinteger (int64)
name requiredstring
queues requiredinteger (int64)
role requiredstring
rx_bytes requiredinteger (int64)
rx_dropped requiredinteger (int64)
rx_errors requiredinteger (int64)
rx_packets requiredinteger (int64)
speed_mbps requiredinteger (int64)
state requiredstring
tx_bytes requiredinteger (int64)
tx_dropped requiredinteger (int64)
tx_errors requiredinteger (int64)
tx_packets requiredinteger (int64)
xdp_mode requiredstring

NoteRequest

text requiredstring

NotifyChange

applied requiredboolean
channelChannelView | null
rev requiredinteger (int64)
ruleNotifyRule | null

NotifyMeta

channel_types requiredarray of string
events requiredarray of EventMeta
severities requiredarray of string

NotifyRule

channels requiredarray of string
cooldown_sinteger (int64)
enabled requiredboolean
events requiredarray of string
id requiredstring
min_severitystring
name requiredstring
prefix_idsarray of integer (int32)
tenantstring
vectorsarray of string

NotifyTestResult

errorstring
ok requiredboolean
took_ms requiredinteger (int64)

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)

OwnEntry

added requiredstring (date-time)
bystring
category requiredstring
cidr requiredstring
commentstring
expires requiredstring (date-time)

PSU

name requiredstring
status requiredstring
wattsnumber

PayloadMatch

asciistring
hexstring
maskstring
offsetinteger (int64) | null
templatestring

PayloadTemplate

example_portsstring
hex requiredstring
mask requiredstring
name requiredstring
note requiredstring
offset requiredinteger (int64)
proto requiredstring
title requiredstring

PayloadTemplateList

items requiredarray of PayloadTemplate

PcapMeta

bystring
bytes requiredinteger (int64)
duration_s requiredinteger (int64)
endedstring (date-time) | null
ends requiredstring (date-time)
errorstring
file_size requiredinteger (int64)
filter requiredFilterSpec
filtered requiredinteger (int64)
id requiredstring
incident_idstring
kernel_lost requiredinteger (int64)
kernel_rate_limited requiredinteger (int64)
max_pps requiredinteger (int64)
packets requiredinteger (int64)
prefix requiredstring
prefix_id requiredinteger (int32)
rate_limited_user requiredinteger (int64)
snaplen requiredinteger (int64)
source requiredstring
started requiredstring (date-time)
status requiredstring
verdicts requiredarray of string

PeerStatus

diag requiredstring
errorstring
interval_ms requiredinteger (int64)
localstring
multiplier requiredinteger (int64)
name requiredstring
peer requiredstring
remote_state requiredstring
sending requiredboolean
since requiredstring (date-time)
state requiredstring

Port

address requiredstring
extra_addressesarray of string
interface requiredstring

PortalView

appliance_fp requiredstring
client_fps requiredarray of string
customer_port requiredinteger (int64)
last_errorstring
listening requiredobject
managed requiredboolean
mssp_port requiredinteger (int64)
servers requiredarray of string

PrefixAssignment

cidr requiredstring
group requiredinteger (int32)
id requiredinteger (int32)
mode requiredstring
profile requiredinteger (int32)
tenantstring

PrefixChange

applied requiredboolean
changes requiredarray of Change
etag requiredstring
impact requiredImpact
no_change requiredboolean
prefix requiredPrefixAssignment
revision requiredinteger (int64)
summary requiredstring
warnings requiredarray of string

PrefixImpact

cidr requiredstring
id requiredinteger (int32)
live requiredboolean
mode requiredstring
tenantstring

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

PrefixPatch

description requiredstring | null
group requiredinteger (int32) | null
mode requiredstring | null
profile requiredinteger (int32) | null

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

Profile

ack_validateAckValidate | null
amplification requiredAmplification | null
detection requiredDetection | null
geoGeo | null
id requiredinteger (int32)
name requiredstring
proto_allow requiredarray of string
reputationmap of string
reputation_limiterstring
rules requiredarray of ConfigRule
syn_auth requiredSynAuth | null
tcp_sanityboolean

ProfileChange

applied requiredboolean
changes requiredarray of Change
etag requiredstring
impact requiredImpact
no_change requiredboolean
profile requiredProfile
revision requiredinteger (int64)
summary requiredstring
warnings requiredarray of string

ProfileUse

cidr requiredstring
id requiredinteger (int32)
mode requiredstring
tenantstring

ProfileView

id requiredinteger (int32)
name requiredstring
profile requiredProfile
rule_hits requiredarray of RuleHit
source requiredstring
used_by requiredarray of ProfileUse

ProtChange

applied requiredboolean
changes requiredarray of Change
etag requiredstring
impact requiredImpact
no_change requiredboolean
revision requiredinteger (int64)
summary requiredstring
warnings requiredarray of string

Protection

allow requiredarray of ListEntry
deny requiredarray of ListEntry
groups requiredarray of Group
limiters requiredarray of Limiter
profiles requiredarray of Profile

ProtectionSummary

allow requiredCountPair
deny requiredCountPair
etag requiredstring
groups requiredinteger (int64)
limiters requiredCountPair
prefixes requiredinteger (int64)
profiles requiredCountPair
revision requiredinteger (int64)
updated requiredstring (date-time)
warnings requiredarray of string

ProtoPoint

icmp requirednumber
other requirednumber
t requiredinteger (int64)
tcp requirednumber
udp requirednumber

ProtoSeriesResponse

from requiredstring (date-time)
points requiredarray of ProtoPoint
res requiredstring
to requiredstring (date-time)

ProtoView

proto requiredinteger (int32)
stats requiredStats

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)

ReleaseInfo

created requiredstring (date-time)
current requiredboolean
notesstring
version requiredstring

RepStat

category requiredstring
stats requiredStats

ReportGenerateRequest

daystring
deliverarray of string
fromstring
incident_idstring
monthstring
namestring
sla_target_msinteger (int64)
tenantstring
tostring
type requiredstring
tzstring

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

RevisionDetail

diff requiredarray of Change
diff_available requiredboolean
parent requiredinteger (int64)
protection requiredProtection
rev requiredinteger (int64)
rollback_ofinteger (int64)
sha256 requiredstring
summary requiredstring
time requiredstring (date-time)
user requiredstring

RevisionList

items requiredarray of RevisionMeta
next requiredstring | null

RevisionMeta

parent requiredinteger (int64)
rev requiredinteger (int64)
rollback_ofinteger (int64)
sha256 requiredstring
summary requiredstring
time requiredstring (date-time)
user requiredstring

RoutedConfig

bfdBFD | null
downstream requiredPort
enabled requiredboolean
forward_unprotectedboolean
maintenanceboolean
next_hop requiredstring
return_via_upstreamboolean
upstream requiredPort
upstream_peerstring

RoutedStatus

downstream_up requiredboolean
enabled requiredboolean
forward_unprotected requiredboolean
last_errorstring
next_hop_ok requiredboolean
prefixes requiredarray of string
return_path requiredboolean
routes requiredinteger (int64)
updated requiredstring (date-time)
upstream_up requiredboolean

RoutedView

config requiredRoutedConfig
status requiredRoutedStatus

RuleHit

bytes requiredinteger (int64)
drop_packets requiredinteger (int64)
index requiredinteger (int64)
name requiredstring
packets requiredinteger (int64)

RuleInfo

action requiredinteger (int32)
flags requiredinteger (int32)
index requiredinteger (int64)
limiter requiredinteger (int32)
match requiredstring
profile requiredinteger (int32)
stats requiredStats

Schedule

dayinteger (int64)
hourinteger (int64)
kind requiredstring
tzstring
weekdayinteger (int64)

ScheduleChange

applied requiredboolean
definitionDefinition | null
rev requiredinteger (int64)

ScheduleInfo

deliverarray of string
enabled requiredboolean
id requiredstring
last_runstring (date-time) | null
name requiredstring
next_runstring (date-time) | null
schedule requiredSchedule
sla_target_msinteger (int64)
tenantstring
type requiredstring

SelfProtCounter

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

SelfProtRuleView

bytes requiredinteger (int64)
implicit requiredboolean
namestring
packets requiredinteger (int64)
slot requiredinteger (int64)

SelfProtSeenView

bytes requiredinteger (int64)
family requiredinteger (int64)
packets requiredinteger (int64)
port requiredinteger (int32)
proto requiredinteger (int32)
proto_name requiredstring
suggested_rulestring

SelfProtStatus

addresses requiredarray of string
configured requiredboolean
expiredboolean
icmp_echo_limited requiredboolean
mode requiredstring
pending_bystring
pending_confirm_snumber
rules requiredarray of SelfProtRuleView
source_set_entries requiredinteger (int64)
stats requiredmap of SelfProtCounter

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)

SessionSettings

idle_minutes requiredinteger (int64)
max_hours requiredinteger (int64)

SetPasswordRequest

must_change requiredboolean | null
password requiredstring

Share

est_pps requirednumber
name requiredstring
share requirednumber

State

autoneg requiredboolean
fec_activestring
fec_configuredstring
link requiredboolean
name requiredstring
speed_mbps requiredinteger (int64)

Stats

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

SuggestReport

attack_samples requiredinteger (int64)
attack_weight requirednumber
notesarray of string
pass_samples requiredinteger (int64)
pass_weight requirednumber
suggestions requiredarray of Suggestion

Suggestion

attack_samples requiredinteger (int64)
collateral requirednumber
coverage requirednumber
pass_samples requiredinteger (int64)
rationale requiredstring
recommended requiredstring
risk requiredstring
rule requiredConfigRule
total_coverage requirednumber

SuggestionsView

incident_id requiredstring
prefix_id requiredinteger (int32)
profile_id requiredinteger (int32)
report requiredSuggestReport

SynAuth

drop_nonsyn requiredboolean
enabled requiredboolean
validity_s requiredinteger (int64)

SynAuthInfo

SecretSet requiredboolean
Total4 requiredinteger (int64)
Total6 requiredinteger (int64)
Validated4 requiredinteger (int64)
Validated6 requiredinteger (int64)
WindowNS requiredinteger (int64)

SystemHealthResponse

audit requiredAuditInfo
host requiredSystemHost
telemetry requiredTelemetryStatus | null
tls requiredTlsutilCertInfo | null
wsd requiredWsdInfo

SystemHistory

points requiredarray of HistPoint
step_secs requiredinteger (int64)
window_secs requiredinteger (int64)

SystemHost

bmcstring
cores requiredarray of CpuCore
cpus requiredarray of CpuPackage
disk_free requiredinteger (int64)
disk_total requiredinteger (int64)
fans requiredarray of Fan
hostname requiredstring
hw requiredHardware
kernel requiredstring
load1 requirednumber
load15 requirednumber
load5 requirednumber
mem_available requiredinteger (int64)
mem_total requiredinteger (int64)
os_versionstring
power_wnumber
psusarray of PSU
temps requiredarray of TempSensor
uptime_s requirednumber

TIEntryRequest

categorystring
cidr requiredstring
commentstring
ttl_sinteger (int64)

TIFeedRequest

category requiredstring
enabledboolean | null
interval_sinteger (int64)
name requiredstring
url requiredstring

TILookupView

ip requiredstring
matches requiredarray of TiMatch

TIStatusView

age_s requirednumber
applied_atstring (date-time) | null
createdstring (date-time) | null
effective requiredinteger (int64)
entries requiredmap of integer (int64)
feed requiredstring
key_idstring
last_rejectstring
own requiredinteger (int64)
rejected requiredinteger (int64)
seq requiredinteger (int64)
stale requiredboolean
traffic requiredarray of RepStat
trusted_keys requiredinteger (int64)
url_feed_entries requiredinteger (int64)
url_feeds requiredinteger (int64)

TelemetryStatus

adaptive_adjustments requiredinteger (int64)
adaptive_enabled requiredboolean
adaptive_max_rate requiredinteger (int32)
adaptive_min_rate requiredinteger (int32)
adaptive_target_samples_per_sec requiredinteger (int32)
decode_errors requiredinteger (int64)
disk_bytes requiredinteger (int64)
disk_enabled requiredboolean
disk_errors requiredinteger (int64)
disk_segments requiredinteger (int64)
kernel_sample_lost requiredinteger (int64)
kernel_sampled requiredinteger (int64)
prefix_states requiredinteger (int64)
read_errors requiredinteger (int64)
sample_rate requiredinteger (int32)
samples_processed requiredinteger (int64)
samples_rejected requiredinteger (int64)

TempSensor

celsius requirednumber
sensor requiredstring
statusstring

Template

description requiredstring
id requiredstring
limitersarray of Limiter
name requiredstring
profile requiredProfile

TemplateList

items requiredarray of Template

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

TerminateRequest

relearnboolean

TiMatch

category requiredstring
commentstring
expiresstring
prefix requiredstring
source requiredstring

TlsutilCertInfo

dns_names requiredarray of string
expired requiredboolean
fingerprint requiredstring
ips requiredarray of string
not_after requiredstring (date-time)
not_before requiredstring (date-time)
self_signed requiredboolean
subject 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)

Tunnel

bgpTunnelBGP | null
commentstring
disabledboolean
id requiredinteger (int32)
inner_localstring
inner_peerstring
keyinteger (int32) | null
local requiredstring
mss_clampboolean | null
mtuinteger (int64)
name requiredstring
no_probeboolean
remote requiredstring
routesarray of string
tenant requiredstring
ttlinteger (int64)

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)

URLFeedPatch

categorystring | null
enabledboolean | null
interval_sinteger (int64) | null
namestring | null
urlstring | null

URLFeedView

category requiredstring
enabled requiredboolean
entries requiredinteger (int64)
fetching requiredboolean
id requiredstring
interval_s requiredinteger (int64)
last_attemptstring (date-time) | null
last_errorstring
last_successstring (date-time) | null
name requiredstring
next_duestring (date-time) | null
skipped requiredinteger (int64)
url requiredstring

UpdatePending

boots requiredinteger (int64)
deadline requiredstring (date-time)
from requiredstring
since requiredstring (date-time)
version requiredstring

UpdateStatus

account_idstring
configured requiredboolean
enabled requiredboolean
failures requiredinteger (int64)
interval_h requiredinteger (int64)
key_set requiredboolean
last_attemptstring (date-time) | null
last_errorstring
last_successstring (date-time) | null
nextstring (date-time) | null
running requiredboolean
versionstring

UpdateView

current requiredstring
failedmap of string
history requiredarray of Event
pendingUpdatePending | null
previousstring
releases requiredarray of ReleaseInfo

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)

UserPatch

role requiredstring | null
tenant requiredstring | null
unix_user requiredstring | null
web requiredboolean | null

UserRequest

must_change requiredboolean | null
name requiredstring
password requiredstring
role requiredstring
tenant requiredstring
uid requiredinteger (int64) | null
unix_user requiredstring
web requiredboolean

UserView

authAuthStatus | null
managed requiredboolean
name requiredstring
role requiredstring
tenantstring
uidinteger (int64) | null
unix_userstring
web requiredboolean

Would

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

WsdInfo

interface requiredstring
started requiredstring (date-time)
uptime_s requirednumber
version requiredstring
xdp_mode requiredstring