{
  "components": {
    "schemas": {
      "ACMEView": {
        "properties": {
          "domains": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "email": {
            "type": "string"
          },
          "method": {
            "type": "string"
          },
          "staging": {
            "type": "boolean"
          },
          "token_set": {
            "type": "boolean"
          }
        },
        "required": [
          "domains",
          "method",
          "token_set"
        ],
        "type": "object"
      },
      "ASNNamesResponse": {
        "properties": {
          "names": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          }
        },
        "required": [
          "names"
        ],
        "type": "object"
      },
      "AckInfo": {
        "properties": {
          "Known4": {
            "format": "int64",
            "type": "integer"
          },
          "Known6": {
            "format": "int64",
            "type": "integer"
          },
          "Pending4": {
            "format": "int64",
            "type": "integer"
          },
          "Pending6": {
            "format": "int64",
            "type": "integer"
          },
          "Total4": {
            "format": "int64",
            "type": "integer"
          },
          "Total6": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "Known4",
          "Known6",
          "Pending4",
          "Pending6",
          "Total4",
          "Total6"
        ],
        "type": "object"
      },
      "AckValidate": {
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "ttl_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "enabled",
          "ttl_s"
        ],
        "type": "object"
      },
      "Amplification": {
        "properties": {
          "action": {
            "type": "string"
          },
          "limiter": {
            "type": "string"
          },
          "min_length": {
            "format": "int64",
            "type": "integer"
          },
          "ports": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "preset": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "limiter",
          "min_length",
          "ports",
          "preset"
        ],
        "type": "object"
      },
      "ArchiveFlows": {
        "properties": {
          "archive": {
            "$ref": "#/components/schemas/ArchiveMeta"
          },
          "summary": {
            "$ref": "#/components/schemas/FlowSummary"
          }
        },
        "required": [
          "archive",
          "summary"
        ],
        "type": "object"
      },
      "ArchiveMeta": {
        "properties": {
          "closed": {
            "type": "boolean"
          },
          "dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "end": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "merged": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "partial": {
            "type": "boolean"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "records": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "truncated": {
            "type": "boolean"
          }
        },
        "required": [
          "closed",
          "dropped",
          "id",
          "merged",
          "prefix",
          "prefix_id",
          "records",
          "start",
          "truncated"
        ],
        "type": "object"
      },
      "ArchiveSamples": {
        "properties": {
          "archive": {
            "$ref": "#/components/schemas/ArchiveMeta"
          },
          "next_offset": {
            "format": "int64",
            "type": "integer"
          },
          "samples": {
            "items": {
              "$ref": "#/components/schemas/Rec"
            },
            "type": "array"
          }
        },
        "required": [
          "archive",
          "next_offset",
          "samples"
        ],
        "type": "object"
      },
      "AttackRecord": {
        "properties": {
          "action": {
            "type": "string"
          },
          "bps": {
            "type": "number"
          },
          "by": {
            "type": "string"
          },
          "deadline": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "decision": {
            "type": "string"
          },
          "detect_latency_ms": {
            "format": "int64",
            "type": "integer"
          },
          "dropped_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "duration_s": {
            "type": "number"
          },
          "event": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "incident": {
            "type": "string"
          },
          "on_timeout": {
            "type": "string"
          },
          "peak_bps": {
            "type": "number"
          },
          "peak_pps": {
            "type": "number"
          },
          "pps": {
            "type": "number"
          },
          "prefix": {
            "type": "string"
          },
          "resumed": {
            "type": "boolean"
          },
          "target": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "top": {},
          "vector": {
            "type": "string"
          },
          "vectors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "action",
          "bps",
          "event",
          "id",
          "pps",
          "prefix",
          "time",
          "vector"
        ],
        "type": "object"
      },
      "AttackseriesPoint": {
        "properties": {
          "drop_bps": {
            "type": "number"
          },
          "drop_pps": {
            "type": "number"
          },
          "in_bps": {
            "type": "number"
          },
          "in_pps": {
            "type": "number"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "drop_bps",
          "drop_pps",
          "in_bps",
          "in_pps",
          "t"
        ],
        "type": "object"
      },
      "AuditInfo": {
        "properties": {
          "bytes": {
            "format": "int64",
            "type": "integer"
          },
          "enabled": {
            "type": "boolean"
          },
          "last_hash": {
            "type": "string"
          },
          "records": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "segments": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "enabled",
          "last_hash",
          "records",
          "segments"
        ],
        "type": "object"
      },
      "AuthStatus": {
        "properties": {
          "has_password": {
            "type": "boolean"
          },
          "locked": {
            "type": "boolean"
          },
          "locked_until": {
            "format": "date-time",
            "type": "string"
          },
          "must_change": {
            "type": "boolean"
          },
          "recovery_codes": {
            "format": "int64",
            "type": "integer"
          },
          "sessions": {
            "format": "int64",
            "type": "integer"
          },
          "tokens": {
            "format": "int64",
            "type": "integer"
          },
          "totp": {
            "type": "string"
          }
        },
        "required": [
          "has_password",
          "locked",
          "must_change",
          "recovery_codes",
          "sessions",
          "tokens",
          "totp"
        ],
        "type": "object"
      },
      "BFD": {
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "interval_ms": {
            "format": "int64",
            "type": "integer"
          },
          "multiplier": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "enabled"
        ],
        "type": "object"
      },
      "BFDView": {
        "properties": {
          "downstream_address": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "health_reason": {
            "type": "string"
          },
          "healthy": {
            "type": "boolean"
          },
          "interval_ms": {
            "format": "int64",
            "type": "integer"
          },
          "maintenance": {
            "type": "boolean"
          },
          "multiplier": {
            "format": "int64",
            "type": "integer"
          },
          "next_hop": {
            "type": "string"
          },
          "peers": {
            "items": {
              "$ref": "#/components/schemas/PeerStatus"
            },
            "type": "array"
          },
          "upstream_address": {
            "type": "string"
          },
          "upstream_peer": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "healthy",
          "interval_ms",
          "maintenance",
          "multiplier",
          "peers"
        ],
        "type": "object"
      },
      "BGPCustomers": {
        "properties": {
          "profiles": {
            "additionalProperties": {
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            },
            "type": "object"
          },
          "rtbh": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "BGPIRR": {
        "properties": {
          "refresh_h": {
            "format": "int64",
            "type": "integer"
          },
          "server": {
            "type": "string"
          },
          "sources": {
            "type": "string"
          }
        },
        "required": [
          "server"
        ],
        "type": "object"
      },
      "BGPIRRView": {
        "properties": {
          "as_sets": {
            "format": "int64",
            "type": "integer"
          },
          "asns": {
            "format": "int64",
            "type": "integer"
          },
          "error": {
            "type": "string"
          },
          "last_fetch": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "server": {
            "type": "string"
          }
        },
        "required": [
          "as_sets",
          "asns",
          "prefixes",
          "server"
        ],
        "type": "object"
      },
      "BGPPrefixView": {
        "properties": {
          "accepted": {
            "type": "boolean"
          },
          "advertised": {
            "type": "boolean"
          },
          "as_path": {
            "items": {
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "irr": {
            "type": "string"
          },
          "origin": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "peer": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "routed": {
            "type": "boolean"
          },
          "rpki": {
            "type": "string"
          },
          "since": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "tunnel": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "accepted",
          "advertised",
          "as_path",
          "irr",
          "origin",
          "peer",
          "prefix",
          "routed",
          "rpki",
          "status",
          "tenant",
          "tunnel",
          "warnings"
        ],
        "type": "object"
      },
      "BGPRPKI": {
        "properties": {
          "refresh_s": {
            "format": "int64",
            "type": "integer"
          },
          "servers": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "servers"
        ],
        "type": "object"
      },
      "BGPRPKIView": {
        "properties": {
          "error": {
            "type": "string"
          },
          "last_sync": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "roas": {
            "format": "int64",
            "type": "integer"
          },
          "serial": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "server": {
            "type": "string"
          },
          "synced": {
            "type": "boolean"
          },
          "version": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "roas",
          "serial",
          "server",
          "synced",
          "version"
        ],
        "type": "object"
      },
      "BGPRouterSetting": {
        "properties": {
          "address": {
            "type": "string"
          },
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "clear_password": {
            "type": "boolean"
          },
          "local_address": {
            "type": "string"
          },
          "multihop": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "password": {
            "type": "string"
          },
          "password_set": {
            "type": "boolean"
          },
          "ttl_min": {
            "format": "int64",
            "type": "integer"
          },
          "ttl_security": {
            "type": "boolean"
          }
        },
        "required": [
          "address",
          "name",
          "password_set"
        ],
        "type": "object"
      },
      "BGPSessionView": {
        "properties": {
          "accepted": {
            "format": "int64",
            "type": "integer"
          },
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "error": {
            "type": "string"
          },
          "gtsm": {
            "type": "boolean"
          },
          "kind": {
            "type": "string"
          },
          "max_prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "md5": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "peer": {
            "type": "string"
          },
          "received": {
            "format": "int64",
            "type": "integer"
          },
          "since": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "tunnel": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "uptime_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "accepted",
          "asn",
          "gtsm",
          "kind",
          "md5",
          "name",
          "peer",
          "received",
          "state",
          "uptime_s"
        ],
        "type": "object"
      },
      "BGPSettings": {
        "properties": {
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "communities": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "customer_communities": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BGPCustomers"
              }
            ],
            "nullable": true
          },
          "enabled": {
            "type": "boolean"
          },
          "irr": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BGPIRR"
              }
            ],
            "nullable": true
          },
          "listen_port": {
            "format": "int64",
            "type": "integer"
          },
          "managed": {
            "type": "boolean"
          },
          "next_hop": {
            "type": "string"
          },
          "next_hop_v6": {
            "type": "string"
          },
          "router_id": {
            "type": "string"
          },
          "routers": {
            "items": {
              "$ref": "#/components/schemas/BGPRouterSetting"
            },
            "type": "array"
          },
          "rpki": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BGPRPKI"
              }
            ],
            "nullable": true
          },
          "rtbh_communities": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "rtbh_next_hop": {
            "type": "string"
          },
          "rtbh_next_hop_v6": {
            "type": "string"
          }
        },
        "required": [
          "asn",
          "communities",
          "enabled",
          "managed",
          "next_hop",
          "router_id",
          "routers"
        ],
        "type": "object"
      },
      "BGPStaticView": {
        "properties": {
          "advertised": {
            "type": "boolean"
          },
          "error": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          }
        },
        "required": [
          "advertised",
          "prefix"
        ],
        "type": "object"
      },
      "BGPStatusView": {
        "properties": {
          "accepted_total": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "active": {
            "format": "int64",
            "type": "integer"
          },
          "enabled": {
            "type": "boolean"
          },
          "engine_error": {
            "type": "string"
          },
          "established": {
            "format": "int64",
            "type": "integer"
          },
          "flaps_total": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "irr": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BGPIRRView"
              }
            ],
            "nullable": true
          },
          "prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "rejected_total": {
            "additionalProperties": {
              "format": "int64",
              "minimum": 0,
              "type": "integer"
            },
            "type": "object"
          },
          "rpki": {
            "items": {
              "$ref": "#/components/schemas/BGPRPKIView"
            },
            "type": "array"
          },
          "running": {
            "type": "boolean"
          },
          "sessions": {
            "format": "int64",
            "type": "integer"
          },
          "static_routes": {
            "items": {
              "$ref": "#/components/schemas/BGPStaticView"
            },
            "type": "array"
          },
          "withdrawn_total": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "active",
          "enabled",
          "established",
          "prefixes",
          "running",
          "sessions"
        ],
        "type": "object"
      },
      "Baseline": {
        "properties": {
          "alpha": {
            "type": "number"
          },
          "factor": {
            "type": "number"
          },
          "min_bps": {
            "type": "number"
          },
          "min_pps": {
            "type": "number"
          },
          "warmup_ticks": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "alpha",
          "factor",
          "min_bps",
          "min_pps",
          "warmup_ticks"
        ],
        "type": "object"
      },
      "Capabilities": {
        "properties": {
          "bgp": {
            "type": "boolean"
          },
          "flowspec": {
            "type": "boolean"
          },
          "gre": {
            "type": "boolean"
          },
          "incident_notes": {
            "type": "boolean"
          },
          "incident_terminate": {
            "type": "boolean"
          },
          "incidents": {
            "type": "boolean"
          },
          "interfaces": {
            "type": "boolean"
          },
          "license": {
            "type": "boolean"
          },
          "notifications": {
            "type": "boolean"
          },
          "pcap": {
            "type": "boolean"
          },
          "protection_editor": {
            "type": "boolean"
          },
          "reports_pdf": {
            "type": "boolean"
          },
          "rtbh": {
            "type": "boolean"
          },
          "sampling": {
            "type": "boolean"
          },
          "telemetry": {
            "type": "boolean"
          },
          "tenants": {
            "type": "boolean"
          },
          "threat_intel": {
            "type": "boolean"
          },
          "updates": {
            "type": "boolean"
          },
          "usage_billing": {
            "type": "boolean"
          },
          "users": {
            "type": "boolean"
          }
        },
        "required": [
          "bgp",
          "flowspec",
          "gre",
          "incident_notes",
          "incident_terminate",
          "incidents",
          "interfaces",
          "license",
          "notifications",
          "pcap",
          "protection_editor",
          "reports_pdf",
          "rtbh",
          "sampling",
          "telemetry",
          "tenants",
          "threat_intel",
          "updates",
          "usage_billing",
          "users"
        ],
        "type": "object"
      },
      "CaptureList": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/PcapMeta"
            },
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "CaptureRequest": {
        "properties": {
          "duration_s": {
            "format": "int64",
            "type": "integer"
          },
          "filter": {
            "$ref": "#/components/schemas/FilterSpec"
          },
          "max_pps": {
            "format": "int64",
            "type": "integer"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "snaplen": {
            "format": "int64",
            "type": "integer"
          },
          "verdicts": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "duration_s",
          "filter",
          "max_pps",
          "prefix_id",
          "snaplen",
          "verdicts"
        ],
        "type": "object"
      },
      "CertmgrCertInfo": {
        "properties": {
          "dns_names": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "fingerprint": {
            "type": "string"
          },
          "ips": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "issuer": {
            "type": "string"
          },
          "not_after": {
            "format": "date-time",
            "type": "string"
          },
          "not_before": {
            "format": "date-time",
            "type": "string"
          },
          "self_signed": {
            "type": "boolean"
          },
          "subject": {
            "type": "string"
          }
        },
        "required": [
          "dns_names",
          "fingerprint",
          "ips",
          "issuer",
          "not_after",
          "not_before",
          "self_signed",
          "subject"
        ],
        "type": "object"
      },
      "CertmgrStatus": {
        "properties": {
          "acme": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ACMEView"
              }
            ],
            "nullable": true
          },
          "cert": {
            "allOf": [
              {
                "$ref": "#/components/schemas/CertmgrCertInfo"
              }
            ],
            "nullable": true
          },
          "last_attempt": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "last_error": {
            "type": "string"
          },
          "last_success": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "methods": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "running": {
            "type": "boolean"
          },
          "source": {
            "type": "string"
          }
        },
        "required": [
          "methods",
          "running",
          "source"
        ],
        "type": "object"
      },
      "Change": {
        "properties": {
          "fields": {
            "items": {
              "$ref": "#/components/schemas/FieldChange"
            },
            "type": "array"
          },
          "key": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "op": {
            "type": "string"
          }
        },
        "required": [
          "fields",
          "key",
          "kind",
          "op"
        ],
        "type": "object"
      },
      "ChannelInput": {
        "properties": {
          "address": {
            "type": "string"
          },
          "allow_insecure": {
            "type": "boolean"
          },
          "base_url": {
            "type": "string"
          },
          "ca_file": {
            "type": "string"
          },
          "chat_id": {
            "type": "string"
          },
          "clear_secret": {
            "type": "boolean"
          },
          "customer_relay": {
            "type": "boolean"
          },
          "customer_url": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "enterprise_oid": {
            "type": "string"
          },
          "facility": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "from": {
            "type": "string"
          },
          "headers": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "panel_url": {
            "type": "string"
          },
          "secret": {
            "type": "string"
          },
          "security": {
            "type": "string"
          },
          "subject_prefix": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "to": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "via": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "id",
          "name",
          "type"
        ],
        "type": "object"
      },
      "ChannelStats": {
        "properties": {
          "dead": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "enabled": {
            "type": "boolean"
          },
          "failed": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "type": "string"
          },
          "last_error": {
            "type": "string"
          },
          "last_error_at": {
            "format": "date-time",
            "type": "string"
          },
          "last_success": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "queued": {
            "format": "int64",
            "type": "integer"
          },
          "sent": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "suppressed": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "dead",
          "dropped",
          "enabled",
          "failed",
          "id",
          "name",
          "queued",
          "sent",
          "suppressed",
          "type"
        ],
        "type": "object"
      },
      "ChannelView": {
        "properties": {
          "address": {
            "type": "string"
          },
          "allow_insecure": {
            "type": "boolean"
          },
          "base_url": {
            "type": "string"
          },
          "ca_file": {
            "type": "string"
          },
          "chat_id": {
            "type": "string"
          },
          "customer_relay": {
            "type": "boolean"
          },
          "customer_url": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "enterprise_oid": {
            "type": "string"
          },
          "facility": {
            "type": "string"
          },
          "format": {
            "type": "string"
          },
          "from": {
            "type": "string"
          },
          "headers": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "id": {
            "type": "string"
          },
          "language": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "panel_url": {
            "type": "string"
          },
          "secret": {
            "type": "string"
          },
          "secret_set": {
            "type": "boolean"
          },
          "security": {
            "type": "string"
          },
          "stats": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ChannelStats"
              }
            ],
            "nullable": true
          },
          "subject_prefix": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "to": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "type": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "username": {
            "type": "string"
          },
          "via": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "id",
          "name",
          "secret_set",
          "type"
        ],
        "type": "object"
      },
      "ClassReport": {
        "properties": {
          "bps": {
            "$ref": "#/components/schemas/Quantiles"
          },
          "current": {
            "$ref": "#/components/schemas/LearnThreshold"
          },
          "name": {
            "type": "string"
          },
          "pps": {
            "$ref": "#/components/schemas/Quantiles"
          },
          "suggested": {
            "$ref": "#/components/schemas/LearnThreshold"
          }
        },
        "required": [
          "bps",
          "current",
          "name",
          "pps",
          "suggested"
        ],
        "type": "object"
      },
      "ClassStat": {
        "properties": {
          "excess": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "packets": {
            "type": "number"
          }
        },
        "required": [
          "name",
          "packets"
        ],
        "type": "object"
      },
      "ClassView": {
        "properties": {
          "classes": {
            "items": {
              "$ref": "#/components/schemas/NamedStats"
            },
            "type": "array"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "prefix": {
            "type": "string"
          }
        },
        "required": [
          "classes",
          "id",
          "prefix"
        ],
        "type": "object"
      },
      "Collector": {
        "properties": {
          "active_timeout_s": {
            "format": "int64",
            "type": "integer"
          },
          "address": {
            "type": "string"
          },
          "agent_address": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "if_index": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "observation_domain": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "prefix_ids": {
            "items": {
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            },
            "type": "array"
          },
          "sub_agent_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "template_refresh_s": {
            "format": "int64",
            "type": "integer"
          },
          "transport": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "verdicts": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "address",
          "enabled",
          "id",
          "type"
        ],
        "type": "object"
      },
      "ConfigApproval": {
        "properties": {
          "on_timeout": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "timeout_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "required"
        ],
        "type": "object"
      },
      "ConfigMatch": {
        "properties": {
          "any": {
            "type": "boolean"
          },
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "country": {
            "type": "string"
          },
          "dst_port": {
            "type": "string"
          },
          "fragment": {
            "type": "string"
          },
          "icmp_code": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "icmp_type": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "length": {
            "type": "string"
          },
          "payload": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PayloadMatch"
              }
            ],
            "nullable": true
          },
          "proto": {
            "type": "string"
          },
          "src_port": {
            "type": "string"
          },
          "tcp_flags": {
            "type": "string"
          },
          "ttl": {
            "type": "string"
          }
        },
        "required": [
          "any",
          "dst_port",
          "fragment",
          "icmp_code",
          "icmp_type",
          "length",
          "proto",
          "src_port",
          "tcp_flags",
          "ttl"
        ],
        "type": "object"
      },
      "ConfigRule": {
        "properties": {
          "action": {
            "type": "string"
          },
          "limiter": {
            "type": "string"
          },
          "match": {
            "$ref": "#/components/schemas/ConfigMatch"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "limiter",
          "match",
          "name"
        ],
        "type": "object"
      },
      "ConfigThreshold": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "pps": {
            "type": "number"
          }
        },
        "required": [
          "bps",
          "pps"
        ],
        "type": "object"
      },
      "CountPair": {
        "properties": {
          "managed": {
            "format": "int64",
            "type": "integer"
          },
          "static": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "managed",
          "static"
        ],
        "type": "object"
      },
      "Counters": {
        "properties": {
          "global": {
            "items": {
              "$ref": "#/components/schemas/NamedStats"
            },
            "type": "array"
          },
          "reasons": {
            "items": {
              "$ref": "#/components/schemas/NamedStats"
            },
            "type": "array"
          }
        },
        "required": [
          "global",
          "reasons"
        ],
        "type": "object"
      },
      "CpuCore": {
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "used_pct": {
            "type": "number"
          }
        },
        "required": [
          "id",
          "used_pct"
        ],
        "type": "object"
      },
      "CpuPackage": {
        "properties": {
          "cores": {
            "format": "int64",
            "type": "integer"
          },
          "cpu_ids": {
            "items": {
              "format": "int64",
              "type": "integer"
            },
            "type": "array"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "model": {
            "type": "string"
          },
          "temp_c": {
            "type": "number"
          },
          "threads": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "cores",
          "cpu_ids",
          "id",
          "model",
          "temp_c",
          "threads"
        ],
        "type": "object"
      },
      "CustomRuleRequest": {
        "properties": {
          "action": {
            "type": "string"
          },
          "bps": {
            "type": "number"
          },
          "disabled": {
            "type": "boolean"
          },
          "expires": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "match": {
            "$ref": "#/components/schemas/ConfigMatch"
          },
          "name": {
            "type": "string"
          },
          "pps": {
            "type": "number"
          },
          "priority": {
            "format": "int64",
            "type": "integer"
          },
          "scope": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "when": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "match",
          "priority",
          "when"
        ],
        "type": "object"
      },
      "CustomRuleView": {
        "properties": {
          "action": {
            "type": "string"
          },
          "active": {
            "type": "boolean"
          },
          "added": {
            "format": "date-time",
            "type": "string"
          },
          "bps": {
            "type": "number"
          },
          "by": {
            "type": "string"
          },
          "disabled": {
            "type": "boolean"
          },
          "expires": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "match": {
            "$ref": "#/components/schemas/ConfigMatch"
          },
          "name": {
            "type": "string"
          },
          "pps": {
            "type": "number"
          },
          "prefix": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "priority": {
            "format": "int64",
            "type": "integer"
          },
          "scope": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          },
          "updated": {
            "format": "date-time",
            "type": "string"
          },
          "when": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "active",
          "added",
          "id",
          "match",
          "prefix",
          "priority",
          "stats",
          "when"
        ],
        "type": "object"
      },
      "CustomRulesView": {
        "properties": {
          "can_edit": {
            "type": "boolean"
          },
          "configured_mode": {
            "type": "string"
          },
          "limit": {
            "format": "int64",
            "type": "integer"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "rules": {
            "items": {
              "$ref": "#/components/schemas/CustomRuleView"
            },
            "type": "array"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "can_edit",
          "configured_mode",
          "limit",
          "prefix",
          "prefix_id",
          "rules"
        ],
        "type": "object"
      },
      "Definition": {
        "properties": {
          "deliver": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "enabled": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "schedule": {
            "$ref": "#/components/schemas/Schedule"
          },
          "sla_target_ms": {
            "format": "int64",
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "id",
          "name",
          "schedule",
          "type"
        ],
        "type": "object"
      },
      "Delivery": {
        "properties": {
          "attempt": {
            "format": "int64",
            "type": "integer"
          },
          "channel": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "result": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "took_ms": {
            "format": "int64",
            "type": "integer"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "channel",
          "name",
          "result",
          "time",
          "title",
          "type"
        ],
        "type": "object"
      },
      "Detection": {
        "properties": {
          "approval": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ConfigApproval"
              }
            ],
            "nullable": true
          },
          "baseline": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Baseline"
              }
            ],
            "nullable": true
          },
          "clear_ticks": {
            "format": "int64",
            "type": "integer"
          },
          "thresholds": {
            "additionalProperties": {
              "$ref": "#/components/schemas/ConfigThreshold"
            },
            "type": "object"
          },
          "trigger_ticks": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "baseline",
          "clear_ticks",
          "thresholds",
          "trigger_ticks"
        ],
        "type": "object"
      },
      "DimSeriesPoint": {
        "properties": {
          "other": {
            "type": "number"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          },
          "values": {
            "items": {
              "type": "number"
            },
            "type": "array"
          }
        },
        "required": [
          "other",
          "t",
          "values"
        ],
        "type": "object"
      },
      "DimSeriesResponse": {
        "properties": {
          "dim": {
            "type": "string"
          },
          "keys": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "metric": {
            "type": "string"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/DimSeriesPoint"
            },
            "type": "array"
          },
          "res": {
            "type": "string"
          }
        },
        "required": [
          "dim",
          "keys",
          "metric",
          "points",
          "res"
        ],
        "type": "object"
      },
      "EscalationDecision": {
        "properties": {
          "ttl_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "EscalationRequest": {
        "properties": {
          "action": {
            "type": "string"
          },
          "dst_ports": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "length": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "proto": {
            "type": "string"
          },
          "rate_bps": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "reason": {
            "type": "string"
          },
          "src_ports": {
            "type": "string"
          },
          "src_prefix": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "ttl_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "kind",
          "prefix",
          "tenant"
        ],
        "type": "object"
      },
      "EscalationView": {
        "properties": {
          "action": {
            "type": "string"
          },
          "advertised": {
            "type": "boolean"
          },
          "created": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "dst_ports": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "expired": {
            "type": "boolean"
          },
          "expires": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "kind": {
            "type": "string"
          },
          "length": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "proto": {
            "type": "string"
          },
          "rate_bps": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "reason": {
            "type": "string"
          },
          "remaining_s": {
            "type": "number"
          },
          "source": {
            "type": "string"
          },
          "src_ports": {
            "type": "string"
          },
          "src_prefix": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "advertised",
          "created",
          "expired",
          "expires",
          "id",
          "kind",
          "prefix",
          "remaining_s",
          "source",
          "status",
          "tenant"
        ],
        "type": "object"
      },
      "Event": {
        "properties": {
          "at": {
            "format": "date-time",
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "at",
          "kind",
          "version"
        ],
        "type": "object"
      },
      "EventMeta": {
        "properties": {
          "severity": {
            "type": "string"
          },
          "staff_only": {
            "type": "boolean"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "severity",
          "staff_only",
          "type"
        ],
        "type": "object"
      },
      "ExportConfig": {
        "properties": {
          "collectors": {
            "items": {
              "$ref": "#/components/schemas/Collector"
            },
            "type": "array"
          }
        },
        "required": [
          "collectors"
        ],
        "type": "object"
      },
      "ExportStatus": {
        "properties": {
          "active_flows": {
            "format": "int64",
            "type": "integer"
          },
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "collector": {
            "$ref": "#/components/schemas/Collector"
          },
          "errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "last_error": {
            "type": "string"
          },
          "last_send": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "messages": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "queue_drops": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "records": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "samples": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "collector",
          "errors",
          "messages",
          "queue_drops",
          "records",
          "samples"
        ],
        "type": "object"
      },
      "ExportView": {
        "properties": {
          "collectors": {
            "items": {
              "$ref": "#/components/schemas/ExportStatus"
            },
            "type": "array"
          },
          "config": {
            "$ref": "#/components/schemas/ExportConfig"
          }
        },
        "required": [
          "collectors",
          "config"
        ],
        "type": "object"
      },
      "Fan": {
        "properties": {
          "name": {
            "type": "string"
          },
          "pct": {
            "type": "number"
          },
          "rpm": {
            "format": "int64",
            "type": "integer"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "rpm"
        ],
        "type": "object"
      },
      "FieldChange": {
        "properties": {
          "new": {},
          "old": {},
          "path": {
            "type": "string"
          }
        },
        "required": [
          "new",
          "old",
          "path"
        ],
        "type": "object"
      },
      "FilterSpec": {
        "properties": {
          "dport": {
            "format": "int64",
            "type": "integer"
          },
          "dst": {
            "type": "string"
          },
          "proto": {
            "type": "string"
          },
          "sport": {
            "format": "int64",
            "type": "integer"
          },
          "src": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "Flow": {
        "properties": {
          "bytes_est": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "dport": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "dst": {
            "type": "string"
          },
          "first_ms": {
            "format": "int64",
            "type": "integer"
          },
          "last_ms": {
            "format": "int64",
            "type": "integer"
          },
          "packets_est": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "proto": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "samples": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sport": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "src": {
            "type": "string"
          },
          "verdict": {
            "type": "string"
          }
        },
        "required": [
          "bytes_est",
          "dst",
          "first_ms",
          "last_ms",
          "packets_est",
          "proto",
          "samples",
          "src",
          "verdict"
        ],
        "type": "object"
      },
      "FlowSummary": {
        "properties": {
          "bytes_est": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "distinct_sources": {
            "format": "int64",
            "type": "integer"
          },
          "flows": {
            "items": {
              "$ref": "#/components/schemas/Flow"
            },
            "type": "array"
          },
          "packets_est": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "total_flows": {
            "format": "int64",
            "type": "integer"
          },
          "truncated": {
            "type": "boolean"
          }
        },
        "required": [
          "bytes_est",
          "distinct_sources",
          "flows",
          "packets_est",
          "total_flows",
          "truncated"
        ],
        "type": "object"
      },
      "Geo": {
        "properties": {
          "action": {
            "type": "string"
          },
          "asns": {
            "items": {
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            },
            "type": "array"
          },
          "countries": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "limiter": {
            "type": "string"
          },
          "mode": {
            "type": "string"
          }
        },
        "required": [
          "action",
          "mode"
        ],
        "type": "object"
      },
      "GeoLookupView": {
        "properties": {
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "country": {
            "type": "string"
          },
          "ip": {
            "type": "string"
          },
          "known": {
            "type": "boolean"
          }
        },
        "required": [
          "ip",
          "known"
        ],
        "type": "object"
      },
      "GeoStats": {
        "properties": {
          "hit": {
            "$ref": "#/components/schemas/Stats"
          },
          "lookups": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "unknown": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "hit",
          "lookups",
          "unknown"
        ],
        "type": "object"
      },
      "GeoStatusView": {
        "properties": {
          "asns": {
            "format": "int64",
            "type": "integer"
          },
          "bytes": {
            "format": "int64",
            "type": "integer"
          },
          "countries": {
            "format": "int64",
            "type": "integer"
          },
          "imported_at": {
            "format": "date-time",
            "type": "string"
          },
          "imported_by": {
            "type": "string"
          },
          "kernel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/GeoStats"
              }
            ],
            "nullable": true
          },
          "loaded": {
            "type": "boolean"
          },
          "seq": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "signer": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "v4": {
            "format": "int64",
            "type": "integer"
          },
          "v6": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "asns",
          "bytes",
          "countries",
          "imported_at",
          "loaded",
          "sha256",
          "source",
          "v4",
          "v6"
        ],
        "type": "object"
      },
      "Group": {
        "properties": {
          "description": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "GroupChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "changes": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "etag": {
            "type": "string"
          },
          "group": {
            "$ref": "#/components/schemas/Group"
          },
          "impact": {
            "$ref": "#/components/schemas/Impact"
          },
          "no_change": {
            "type": "boolean"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "summary": {
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "applied",
          "changes",
          "etag",
          "group",
          "impact",
          "no_change",
          "revision",
          "summary",
          "warnings"
        ],
        "type": "object"
      },
      "GroupView": {
        "properties": {
          "active_attacks": {
            "format": "int64",
            "type": "integer"
          },
          "description": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "modes": {
            "additionalProperties": {
              "format": "int64",
              "type": "integer"
            },
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "source": {
            "type": "string"
          },
          "tenants": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "active_attacks",
          "id",
          "modes",
          "name",
          "prefixes",
          "source",
          "tenants"
        ],
        "type": "object"
      },
      "Hardware": {
        "properties": {
          "bios": {
            "type": "string"
          },
          "board": {
            "type": "string"
          },
          "cpu_count": {
            "format": "int64",
            "type": "integer"
          },
          "cpu_model": {
            "type": "string"
          },
          "product": {
            "type": "string"
          },
          "serial": {
            "type": "string"
          },
          "vendor": {
            "type": "string"
          },
          "virtual": {
            "type": "boolean"
          }
        },
        "required": [
          "bios",
          "board",
          "cpu_count",
          "cpu_model",
          "product",
          "serial",
          "vendor",
          "virtual"
        ],
        "type": "object"
      },
      "HealthResponse": {
        "properties": {
          "status": {
            "type": "string"
          }
        },
        "required": [
          "status"
        ],
        "type": "object"
      },
      "HealthSummary": {
        "properties": {
          "cpu_avg_pct": {
            "type": "number"
          },
          "cpu_max_pct": {
            "type": "number"
          },
          "disk_free_pct": {
            "type": "number"
          },
          "hostname": {
            "type": "string"
          },
          "issues": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "load1": {
            "type": "number"
          },
          "mem_used_pct": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "uptime_s": {
            "type": "number"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "cpu_avg_pct",
          "cpu_max_pct",
          "disk_free_pct",
          "hostname",
          "issues",
          "load1",
          "mem_used_pct",
          "status",
          "uptime_s",
          "version"
        ],
        "type": "object"
      },
      "HistPoint": {
        "properties": {
          "cpu_pct": {
            "type": "number"
          },
          "mem_pct": {
            "type": "number"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          },
          "temp_c": {
            "type": "number"
          }
        },
        "required": [
          "cpu_pct",
          "mem_pct",
          "t",
          "temp_c"
        ],
        "type": "object"
      },
      "HostInfo": {
        "properties": {
          "addr": {
            "type": "string"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "addr",
          "stats"
        ],
        "type": "object"
      },
      "HostRow": {
        "properties": {
          "addr": {
            "type": "string"
          },
          "est_pps": {
            "nullable": true,
            "type": "number"
          },
          "est_share": {
            "nullable": true,
            "type": "number"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "addr",
          "est_pps",
          "est_share",
          "stats"
        ],
        "type": "object"
      },
      "Identity": {
        "properties": {
          "name": {
            "type": "string"
          },
          "pid": {
            "format": "int64",
            "type": "integer"
          },
          "read_only": {
            "type": "boolean"
          },
          "remote": {
            "type": "string"
          },
          "restricted": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "uid": {
            "format": "int64",
            "type": "integer"
          },
          "via": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "pid",
          "role",
          "uid"
        ],
        "type": "object"
      },
      "Impact": {
        "properties": {
          "global": {
            "type": "boolean"
          },
          "live": {
            "format": "int64",
            "type": "integer"
          },
          "prefixes": {
            "items": {
              "$ref": "#/components/schemas/PrefixImpact"
            },
            "type": "array"
          },
          "total": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "global",
          "live",
          "prefixes",
          "total"
        ],
        "type": "object"
      },
      "IncidentApproval": {
        "properties": {
          "deadline": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "decided_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "decided_by": {
            "type": "string"
          },
          "decision": {
            "type": "string"
          },
          "on_timeout": {
            "type": "string"
          },
          "since": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "wait_s": {
            "type": "number"
          }
        },
        "required": [
          "since",
          "status"
        ],
        "type": "object"
      },
      "IncidentDetail": {
        "properties": {
          "action": {
            "type": "string"
          },
          "approval": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncidentApproval"
              }
            ],
            "nullable": true
          },
          "detect_latency_ms": {
            "format": "int64",
            "type": "integer"
          },
          "dropped_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "duration_s": {
            "type": "number"
          },
          "end": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "end_action": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "note_count": {
            "format": "int64",
            "type": "integer"
          },
          "notes": {
            "items": {
              "$ref": "#/components/schemas/IncidentNote"
            },
            "type": "array"
          },
          "peak_bps": {
            "type": "number"
          },
          "peak_pps": {
            "type": "number"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "resumed": {
            "type": "boolean"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "start_bps": {
            "type": "number"
          },
          "start_pps": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "terminated_by": {
            "type": "string"
          },
          "top_end": {},
          "top_start": {},
          "vector": {
            "type": "string"
          },
          "vectors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "action",
          "detect_latency_ms",
          "dropped_packets",
          "duration_s",
          "end",
          "end_action",
          "id",
          "note_count",
          "notes",
          "peak_bps",
          "peak_pps",
          "prefix",
          "prefix_id",
          "resumed",
          "start",
          "start_bps",
          "start_pps",
          "status",
          "vector",
          "vectors"
        ],
        "type": "object"
      },
      "IncidentList": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/IncidentView"
            },
            "type": "array"
          },
          "next": {
            "nullable": true,
            "type": "string"
          },
          "total": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "items",
          "next",
          "total"
        ],
        "type": "object"
      },
      "IncidentNote": {
        "properties": {
          "author": {
            "type": "string"
          },
          "text": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "author",
          "text",
          "time"
        ],
        "type": "object"
      },
      "IncidentView": {
        "properties": {
          "action": {
            "type": "string"
          },
          "approval": {
            "allOf": [
              {
                "$ref": "#/components/schemas/IncidentApproval"
              }
            ],
            "nullable": true
          },
          "detect_latency_ms": {
            "format": "int64",
            "type": "integer"
          },
          "dropped_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "duration_s": {
            "type": "number"
          },
          "end": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "end_action": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "note_count": {
            "format": "int64",
            "type": "integer"
          },
          "peak_bps": {
            "type": "number"
          },
          "peak_pps": {
            "type": "number"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "resumed": {
            "type": "boolean"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "start_bps": {
            "type": "number"
          },
          "start_pps": {
            "type": "number"
          },
          "status": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "terminated_by": {
            "type": "string"
          },
          "top_end": {},
          "top_start": {},
          "vector": {
            "type": "string"
          },
          "vectors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "action",
          "detect_latency_ms",
          "dropped_packets",
          "duration_s",
          "end",
          "end_action",
          "id",
          "note_count",
          "peak_bps",
          "peak_pps",
          "prefix",
          "prefix_id",
          "resumed",
          "start",
          "start_bps",
          "start_pps",
          "status",
          "vector",
          "vectors"
        ],
        "type": "object"
      },
      "Job": {
        "properties": {
          "file": {
            "type": "string"
          },
          "finished": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "output": {
            "type": "string"
          },
          "reboot": {
            "type": "boolean"
          },
          "sha256": {
            "type": "string"
          },
          "size": {
            "format": "int64",
            "type": "integer"
          },
          "started": {
            "format": "date-time",
            "type": "string"
          },
          "state": {
            "type": "string"
          }
        },
        "required": [
          "state"
        ],
        "type": "object"
      },
      "LearnReport": {
        "properties": {
          "attack_s": {
            "type": "number"
          },
          "classes": {
            "items": {
              "$ref": "#/components/schemas/ClassReport"
            },
            "type": "array"
          },
          "last_seen": {
            "format": "date-time",
            "type": "string"
          },
          "min_observed_s": {
            "type": "number"
          },
          "observed_s": {
            "type": "number"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "ready": {
            "type": "boolean"
          },
          "since": {
            "format": "date-time",
            "type": "string"
          },
          "suggested_thresholds_json": {
            "type": "string"
          },
          "would_actions": {
            "items": {
              "$ref": "#/components/schemas/Would"
            },
            "type": "array"
          }
        },
        "required": [
          "attack_s",
          "classes",
          "last_seen",
          "min_observed_s",
          "observed_s",
          "prefix_id",
          "ready",
          "since",
          "suggested_thresholds_json"
        ],
        "type": "object"
      },
      "LearnThreshold": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "pps": {
            "type": "number"
          }
        },
        "required": [
          "bps",
          "pps"
        ],
        "type": "object"
      },
      "LearningView": {
        "properties": {
          "learning": {
            "type": "boolean"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "report": {
            "allOf": [
              {
                "$ref": "#/components/schemas/LearnReport"
              }
            ],
            "nullable": true
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "learning",
          "prefix",
          "prefix_id"
        ],
        "type": "object"
      },
      "License": {
        "properties": {
          "appliance": {
            "type": "string"
          },
          "customer": {
            "type": "string"
          },
          "edition": {
            "type": "string"
          },
          "expires": {
            "format": "date-time",
            "type": "string"
          },
          "features": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "format": {
            "format": "int64",
            "type": "integer"
          },
          "id": {
            "type": "string"
          },
          "issued": {
            "format": "date-time",
            "type": "string"
          },
          "limits": {
            "$ref": "#/components/schemas/Limits"
          },
          "not_before": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "appliance",
          "customer",
          "edition",
          "expires",
          "features",
          "format",
          "id",
          "issued",
          "limits",
          "not_before"
        ],
        "type": "object"
      },
      "LicenseStatus": {
        "properties": {
          "days_left": {
            "format": "int64",
            "type": "integer"
          },
          "enforced": {
            "type": "boolean"
          },
          "evaluation": {
            "type": "boolean"
          },
          "grace_ends": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "license": {
            "allOf": [
              {
                "$ref": "#/components/schemas/License"
              }
            ],
            "nullable": true
          },
          "machine_id": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "state": {
            "type": "string"
          }
        },
        "required": [
          "days_left",
          "enforced",
          "evaluation",
          "machine_id",
          "state"
        ],
        "type": "object"
      },
      "Limiter": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "burst_bytes": {
            "format": "int64",
            "type": "integer"
          },
          "burst_pps": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "pps": {
            "type": "number"
          },
          "scope": {
            "type": "string"
          }
        },
        "required": [
          "bps",
          "burst_bytes",
          "burst_pps",
          "name",
          "pps",
          "scope"
        ],
        "type": "object"
      },
      "LimiterChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "changes": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "etag": {
            "type": "string"
          },
          "impact": {
            "$ref": "#/components/schemas/Impact"
          },
          "limiter": {
            "$ref": "#/components/schemas/Limiter"
          },
          "no_change": {
            "type": "boolean"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "summary": {
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "applied",
          "changes",
          "etag",
          "impact",
          "limiter",
          "no_change",
          "revision",
          "summary",
          "warnings"
        ],
        "type": "object"
      },
      "LimiterInfo": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "buckets": {
            "format": "int64",
            "type": "integer"
          },
          "burst_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "burst_pkts": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "pps": {
            "type": "number"
          },
          "scope": {
            "type": "string"
          }
        },
        "required": [
          "bps",
          "buckets",
          "burst_bytes",
          "burst_pkts",
          "id",
          "pps",
          "scope"
        ],
        "type": "object"
      },
      "LimiterView": {
        "properties": {
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "limiter": {
            "$ref": "#/components/schemas/Limiter"
          },
          "name": {
            "type": "string"
          },
          "source": {
            "type": "string"
          },
          "used_by": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "limiter",
          "name",
          "source",
          "used_by"
        ],
        "type": "object"
      },
      "Limits": {
        "properties": {
          "max_gbps": {
            "format": "int64",
            "type": "integer"
          },
          "max_prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "max_tenants": {
            "format": "int64",
            "type": "integer"
          },
          "max_tunnels": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "max_gbps",
          "max_prefixes",
          "max_tenants",
          "max_tunnels"
        ],
        "type": "object"
      },
      "Link": {
        "properties": {
          "fec": {
            "type": "string"
          },
          "speed": {
            "type": "string"
          }
        },
        "required": [
          "fec",
          "speed"
        ],
        "type": "object"
      },
      "LinkRow": {
        "properties": {
          "configured": {
            "$ref": "#/components/schemas/Link"
          },
          "last_error": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "state": {
            "$ref": "#/components/schemas/State"
          }
        },
        "required": [
          "configured",
          "name",
          "role",
          "state"
        ],
        "type": "object"
      },
      "ListEntry": {
        "properties": {
          "added": {
            "format": "date-time",
            "type": "string"
          },
          "by": {
            "type": "string"
          },
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          }
        },
        "required": [
          "added",
          "cidr"
        ],
        "type": "object"
      },
      "ListEntryRequest": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          }
        },
        "required": [
          "cidr",
          "comment"
        ],
        "type": "object"
      },
      "ListItem": {
        "properties": {
          "added": {
            "format": "date-time",
            "type": "string"
          },
          "by": {
            "type": "string"
          },
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "source": {
            "type": "string"
          }
        },
        "required": [
          "cidr",
          "source"
        ],
        "type": "object"
      },
      "Lists": {
        "properties": {
          "allow": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "deny": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "allow",
          "deny"
        ],
        "type": "object"
      },
      "ListsView": {
        "properties": {
          "allow": {
            "items": {
              "$ref": "#/components/schemas/ListItem"
            },
            "type": "array"
          },
          "deny": {
            "items": {
              "$ref": "#/components/schemas/ListItem"
            },
            "type": "array"
          }
        },
        "required": [
          "allow",
          "deny"
        ],
        "type": "object"
      },
      "MitigationDecision": {
        "properties": {
          "decision": {
            "type": "string"
          },
          "enforced": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          }
        },
        "required": [
          "decision",
          "enforced",
          "id",
          "prefix"
        ],
        "type": "object"
      },
      "MitigationView": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "deadline": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "on_timeout": {
            "type": "string"
          },
          "pps": {
            "type": "number"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "remaining_s": {
            "type": "number"
          },
          "since": {
            "format": "date-time",
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "vector": {
            "type": "string"
          }
        },
        "required": [
          "bps",
          "deadline",
          "id",
          "on_timeout",
          "pps",
          "prefix",
          "prefix_id",
          "remaining_s",
          "since",
          "vector"
        ],
        "type": "object"
      },
      "ModeRequest": {
        "properties": {
          "mode": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "mode"
        ],
        "type": "object"
      },
      "ModeResponse": {
        "properties": {
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "mode",
          "prefix"
        ],
        "type": "object"
      },
      "MyChannel": {
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "self": {
            "type": "boolean"
          },
          "target": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "id",
          "name",
          "target",
          "type"
        ],
        "type": "object"
      },
      "MyDelivery": {
        "properties": {
          "channel": {
            "type": "string"
          },
          "result": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "channel",
          "result",
          "time",
          "title",
          "type"
        ],
        "type": "object"
      },
      "MyGroup": {
        "properties": {
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "prefixes": {
            "items": {
              "$ref": "#/components/schemas/MyPrefix"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "prefixes"
        ],
        "type": "object"
      },
      "MyLimiter": {
        "properties": {
          "bps": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "pps": {
            "type": "number"
          },
          "scope": {
            "type": "string"
          }
        },
        "required": [
          "bps",
          "name",
          "pps",
          "scope"
        ],
        "type": "object"
      },
      "MyNotifications": {
        "properties": {
          "channels": {
            "items": {
              "$ref": "#/components/schemas/MyChannel"
            },
            "type": "array"
          },
          "history": {
            "items": {
              "$ref": "#/components/schemas/MyDelivery"
            },
            "type": "array"
          }
        },
        "required": [
          "channels",
          "history"
        ],
        "type": "object"
      },
      "MyNotifyInput": {
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "events": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "language": {
            "type": "string"
          },
          "recipients": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "enabled",
          "events",
          "language",
          "recipients"
        ],
        "type": "object"
      },
      "MyNotifySettings": {
        "properties": {
          "available": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "event_types": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "events": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "language": {
            "type": "string"
          },
          "recipients": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "sender": {
            "type": "string"
          }
        },
        "required": [
          "available",
          "enabled",
          "event_types",
          "events",
          "language",
          "recipients"
        ],
        "type": "object"
      },
      "MyNotifyTestResult": {
        "properties": {
          "ok": {
            "type": "boolean"
          }
        },
        "required": [
          "ok"
        ],
        "type": "object"
      },
      "MyPrefix": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "configured": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "group": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "cidr",
          "configured",
          "group",
          "id",
          "mode",
          "profile"
        ],
        "type": "object"
      },
      "MyProfile": {
        "properties": {
          "features": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "proto_allow": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "rules": {
            "items": {
              "$ref": "#/components/schemas/MyRule"
            },
            "type": "array"
          }
        },
        "required": [
          "features",
          "id",
          "name",
          "proto_allow",
          "rules"
        ],
        "type": "object"
      },
      "MyProtection": {
        "properties": {
          "groups": {
            "items": {
              "$ref": "#/components/schemas/MyGroup"
            },
            "type": "array"
          },
          "limiters": {
            "items": {
              "$ref": "#/components/schemas/MyLimiter"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          },
          "plan": {
            "type": "string"
          },
          "prefixes": {
            "items": {
              "$ref": "#/components/schemas/MyPrefix"
            },
            "type": "array"
          },
          "profiles": {
            "items": {
              "$ref": "#/components/schemas/MyProfile"
            },
            "type": "array"
          },
          "quota_bps": {
            "type": "number"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "groups",
          "limiters",
          "name",
          "plan",
          "prefixes",
          "profiles",
          "quota_bps",
          "tenant"
        ],
        "type": "object"
      },
      "MyRule": {
        "properties": {
          "action": {
            "type": "string"
          },
          "drops": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "limiter": {
            "type": "string"
          },
          "match": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "action",
          "drops",
          "match",
          "name",
          "packets"
        ],
        "type": "object"
      },
      "NameStatus": {
        "properties": {
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "status"
        ],
        "type": "object"
      },
      "NamedStats": {
        "properties": {
          "name": {
            "type": "string"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "name",
          "stats"
        ],
        "type": "object"
      },
      "NetworkInterface": {
        "properties": {
          "driver": {
            "type": "string"
          },
          "mac": {
            "type": "string"
          },
          "mtu": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "queues": {
            "format": "int64",
            "type": "integer"
          },
          "role": {
            "type": "string"
          },
          "rx_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "speed_mbps": {
            "format": "int64",
            "type": "integer"
          },
          "state": {
            "type": "string"
          },
          "tx_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "xdp_mode": {
            "type": "string"
          }
        },
        "required": [
          "driver",
          "mac",
          "mtu",
          "name",
          "queues",
          "role",
          "rx_bytes",
          "rx_dropped",
          "rx_errors",
          "rx_packets",
          "speed_mbps",
          "state",
          "tx_bytes",
          "tx_dropped",
          "tx_errors",
          "tx_packets",
          "xdp_mode"
        ],
        "type": "object"
      },
      "NoteRequest": {
        "properties": {
          "text": {
            "type": "string"
          }
        },
        "required": [
          "text"
        ],
        "type": "object"
      },
      "NotifyChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "channel": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ChannelView"
              }
            ],
            "nullable": true
          },
          "rev": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rule": {
            "allOf": [
              {
                "$ref": "#/components/schemas/NotifyRule"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "applied",
          "rev"
        ],
        "type": "object"
      },
      "NotifyMeta": {
        "properties": {
          "channel_types": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "events": {
            "items": {
              "$ref": "#/components/schemas/EventMeta"
            },
            "type": "array"
          },
          "severities": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "channel_types",
          "events",
          "severities"
        ],
        "type": "object"
      },
      "NotifyRule": {
        "properties": {
          "channels": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "cooldown_s": {
            "format": "int64",
            "type": "integer"
          },
          "enabled": {
            "type": "boolean"
          },
          "events": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "id": {
            "type": "string"
          },
          "min_severity": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "prefix_ids": {
            "items": {
              "format": "int32",
              "minimum": 0,
              "type": "integer"
            },
            "type": "array"
          },
          "tenant": {
            "type": "string"
          },
          "vectors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "channels",
          "enabled",
          "events",
          "id",
          "name"
        ],
        "type": "object"
      },
      "NotifyTestResult": {
        "properties": {
          "error": {
            "type": "string"
          },
          "ok": {
            "type": "boolean"
          },
          "took_ms": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "ok",
          "took_ms"
        ],
        "type": "object"
      },
      "Overview": {
        "properties": {
          "active_incidents": {
            "items": {
              "$ref": "#/components/schemas/IncidentView"
            },
            "type": "array"
          },
          "capabilities": {
            "$ref": "#/components/schemas/Capabilities"
          },
          "health": {
            "allOf": [
              {
                "$ref": "#/components/schemas/HealthSummary"
              }
            ],
            "nullable": true
          },
          "prefixes": {
            "$ref": "#/components/schemas/PrefixSummary"
          },
          "rates": {
            "allOf": [
              {
                "$ref": "#/components/schemas/RateSnapshot"
              }
            ],
            "nullable": true
          },
          "recent_incidents": {
            "items": {
              "$ref": "#/components/schemas/IncidentView"
            },
            "type": "array"
          },
          "sample_rate": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "scope": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "top_prefixes": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "top_targets": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "totals": {
            "$ref": "#/components/schemas/OverviewTotals"
          }
        },
        "required": [
          "active_incidents",
          "capabilities",
          "health",
          "prefixes",
          "rates",
          "recent_incidents",
          "sample_rate",
          "scope",
          "time",
          "top_prefixes",
          "top_targets",
          "totals"
        ],
        "type": "object"
      },
      "OverviewTotals": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "wd_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "drop_bytes",
          "drop_packets",
          "packets",
          "wd_packets"
        ],
        "type": "object"
      },
      "OwnEntry": {
        "properties": {
          "added": {
            "format": "date-time",
            "type": "string"
          },
          "by": {
            "type": "string"
          },
          "category": {
            "type": "string"
          },
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "expires": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "added",
          "category",
          "cidr",
          "expires"
        ],
        "type": "object"
      },
      "PSU": {
        "properties": {
          "name": {
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "watts": {
            "type": "number"
          }
        },
        "required": [
          "name",
          "status"
        ],
        "type": "object"
      },
      "PayloadMatch": {
        "properties": {
          "ascii": {
            "type": "string"
          },
          "hex": {
            "type": "string"
          },
          "mask": {
            "type": "string"
          },
          "offset": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "template": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "PayloadTemplate": {
        "properties": {
          "example_ports": {
            "type": "string"
          },
          "hex": {
            "type": "string"
          },
          "mask": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "note": {
            "type": "string"
          },
          "offset": {
            "format": "int64",
            "type": "integer"
          },
          "proto": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        },
        "required": [
          "hex",
          "mask",
          "name",
          "note",
          "offset",
          "proto",
          "title"
        ],
        "type": "object"
      },
      "PayloadTemplateList": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/PayloadTemplate"
            },
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "PcapMeta": {
        "properties": {
          "by": {
            "type": "string"
          },
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "duration_s": {
            "format": "int64",
            "type": "integer"
          },
          "ended": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "ends": {
            "format": "date-time",
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "file_size": {
            "format": "int64",
            "type": "integer"
          },
          "filter": {
            "$ref": "#/components/schemas/FilterSpec"
          },
          "filtered": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "type": "string"
          },
          "incident_id": {
            "type": "string"
          },
          "kernel_lost": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "kernel_rate_limited": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "max_pps": {
            "format": "int64",
            "type": "integer"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "rate_limited_user": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "snaplen": {
            "format": "int64",
            "type": "integer"
          },
          "source": {
            "type": "string"
          },
          "started": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "verdicts": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "bytes",
          "duration_s",
          "ends",
          "file_size",
          "filter",
          "filtered",
          "id",
          "kernel_lost",
          "kernel_rate_limited",
          "max_pps",
          "packets",
          "prefix",
          "prefix_id",
          "rate_limited_user",
          "snaplen",
          "source",
          "started",
          "status",
          "verdicts"
        ],
        "type": "object"
      },
      "PeerStatus": {
        "properties": {
          "diag": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "interval_ms": {
            "format": "int64",
            "type": "integer"
          },
          "local": {
            "type": "string"
          },
          "multiplier": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "peer": {
            "type": "string"
          },
          "remote_state": {
            "type": "string"
          },
          "sending": {
            "type": "boolean"
          },
          "since": {
            "format": "date-time",
            "type": "string"
          },
          "state": {
            "type": "string"
          }
        },
        "required": [
          "diag",
          "interval_ms",
          "multiplier",
          "name",
          "peer",
          "remote_state",
          "sending",
          "since",
          "state"
        ],
        "type": "object"
      },
      "Port": {
        "properties": {
          "address": {
            "type": "string"
          },
          "extra_addresses": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "interface": {
            "type": "string"
          }
        },
        "required": [
          "address",
          "interface"
        ],
        "type": "object"
      },
      "PortalView": {
        "properties": {
          "appliance_fp": {
            "type": "string"
          },
          "client_fps": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "customer_port": {
            "format": "int64",
            "type": "integer"
          },
          "last_error": {
            "type": "string"
          },
          "listening": {
            "properties": {
              "customer": {
                "type": "boolean"
              },
              "mssp": {
                "type": "boolean"
              }
            },
            "required": [
              "customer",
              "mssp"
            ],
            "type": "object"
          },
          "managed": {
            "type": "boolean"
          },
          "mssp_port": {
            "format": "int64",
            "type": "integer"
          },
          "servers": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "appliance_fp",
          "client_fps",
          "customer_port",
          "listening",
          "managed",
          "mssp_port",
          "servers"
        ],
        "type": "object"
      },
      "PrefixAssignment": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "group": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "cidr",
          "group",
          "id",
          "mode",
          "profile"
        ],
        "type": "object"
      },
      "PrefixChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "changes": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "etag": {
            "type": "string"
          },
          "impact": {
            "$ref": "#/components/schemas/Impact"
          },
          "no_change": {
            "type": "boolean"
          },
          "prefix": {
            "$ref": "#/components/schemas/PrefixAssignment"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "summary": {
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "applied",
          "changes",
          "etag",
          "impact",
          "no_change",
          "prefix",
          "revision",
          "summary",
          "warnings"
        ],
        "type": "object"
      },
      "PrefixImpact": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "live": {
            "type": "boolean"
          },
          "mode": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "cidr",
          "id",
          "live",
          "mode"
        ],
        "type": "object"
      },
      "PrefixListAdd": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          }
        },
        "required": [
          "cidr"
        ],
        "type": "object"
      },
      "PrefixListEntry": {
        "properties": {
          "added": {
            "format": "date-time",
            "type": "string"
          },
          "by": {
            "type": "string"
          },
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "prefix": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "added",
          "cidr",
          "kind",
          "prefix"
        ],
        "type": "object"
      },
      "PrefixListView": {
        "properties": {
          "allow": {
            "items": {
              "$ref": "#/components/schemas/PrefixListEntry"
            },
            "type": "array"
          },
          "can_edit": {
            "type": "boolean"
          },
          "deny": {
            "items": {
              "$ref": "#/components/schemas/PrefixListEntry"
            },
            "type": "array"
          },
          "limit": {
            "format": "int64",
            "type": "integer"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "allow",
          "can_edit",
          "deny",
          "limit",
          "prefix",
          "prefix_id"
        ],
        "type": "object"
      },
      "PrefixPatch": {
        "properties": {
          "description": {
            "nullable": true,
            "type": "string"
          },
          "group": {
            "format": "int32",
            "minimum": 0,
            "nullable": true,
            "type": "integer"
          },
          "mode": {
            "nullable": true,
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "nullable": true,
            "type": "integer"
          }
        },
        "required": [
          "description",
          "group",
          "mode",
          "profile"
        ],
        "type": "object"
      },
      "PrefixSummary": {
        "properties": {
          "bypass": {
            "format": "int64",
            "type": "integer"
          },
          "enforce": {
            "format": "int64",
            "type": "integer"
          },
          "sensor": {
            "format": "int64",
            "type": "integer"
          },
          "total": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "bypass",
          "enforce",
          "sensor",
          "total"
        ],
        "type": "object"
      },
      "PrefixView": {
        "properties": {
          "configured_mode": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "group": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode_name": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "group",
          "id",
          "mode",
          "mode_name",
          "prefix",
          "profile",
          "stats"
        ],
        "type": "object"
      },
      "Profile": {
        "properties": {
          "ack_validate": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AckValidate"
              }
            ],
            "nullable": true
          },
          "amplification": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Amplification"
              }
            ],
            "nullable": true
          },
          "detection": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Detection"
              }
            ],
            "nullable": true
          },
          "geo": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Geo"
              }
            ],
            "nullable": true
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "proto_allow": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "reputation": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "reputation_limiter": {
            "type": "string"
          },
          "rules": {
            "items": {
              "$ref": "#/components/schemas/ConfigRule"
            },
            "type": "array"
          },
          "syn_auth": {
            "allOf": [
              {
                "$ref": "#/components/schemas/SynAuth"
              }
            ],
            "nullable": true
          },
          "tcp_sanity": {
            "type": "boolean"
          }
        },
        "required": [
          "amplification",
          "detection",
          "id",
          "name",
          "proto_allow",
          "rules",
          "syn_auth"
        ],
        "type": "object"
      },
      "ProfileChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "changes": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "etag": {
            "type": "string"
          },
          "impact": {
            "$ref": "#/components/schemas/Impact"
          },
          "no_change": {
            "type": "boolean"
          },
          "profile": {
            "$ref": "#/components/schemas/Profile"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "summary": {
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "applied",
          "changes",
          "etag",
          "impact",
          "no_change",
          "profile",
          "revision",
          "summary",
          "warnings"
        ],
        "type": "object"
      },
      "ProfileUse": {
        "properties": {
          "cidr": {
            "type": "string"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          }
        },
        "required": [
          "cidr",
          "id",
          "mode"
        ],
        "type": "object"
      },
      "ProfileView": {
        "properties": {
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "profile": {
            "$ref": "#/components/schemas/Profile"
          },
          "rule_hits": {
            "items": {
              "$ref": "#/components/schemas/RuleHit"
            },
            "type": "array"
          },
          "source": {
            "type": "string"
          },
          "used_by": {
            "items": {
              "$ref": "#/components/schemas/ProfileUse"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "name",
          "profile",
          "rule_hits",
          "source",
          "used_by"
        ],
        "type": "object"
      },
      "ProtChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "changes": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "etag": {
            "type": "string"
          },
          "impact": {
            "$ref": "#/components/schemas/Impact"
          },
          "no_change": {
            "type": "boolean"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "summary": {
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "applied",
          "changes",
          "etag",
          "impact",
          "no_change",
          "revision",
          "summary",
          "warnings"
        ],
        "type": "object"
      },
      "Protection": {
        "properties": {
          "allow": {
            "items": {
              "$ref": "#/components/schemas/ListEntry"
            },
            "type": "array"
          },
          "deny": {
            "items": {
              "$ref": "#/components/schemas/ListEntry"
            },
            "type": "array"
          },
          "groups": {
            "items": {
              "$ref": "#/components/schemas/Group"
            },
            "type": "array"
          },
          "limiters": {
            "items": {
              "$ref": "#/components/schemas/Limiter"
            },
            "type": "array"
          },
          "profiles": {
            "items": {
              "$ref": "#/components/schemas/Profile"
            },
            "type": "array"
          }
        },
        "required": [
          "allow",
          "deny",
          "groups",
          "limiters",
          "profiles"
        ],
        "type": "object"
      },
      "ProtectionSummary": {
        "properties": {
          "allow": {
            "$ref": "#/components/schemas/CountPair"
          },
          "deny": {
            "$ref": "#/components/schemas/CountPair"
          },
          "etag": {
            "type": "string"
          },
          "groups": {
            "format": "int64",
            "type": "integer"
          },
          "limiters": {
            "$ref": "#/components/schemas/CountPair"
          },
          "prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "profiles": {
            "$ref": "#/components/schemas/CountPair"
          },
          "revision": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "updated": {
            "format": "date-time",
            "type": "string"
          },
          "warnings": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "allow",
          "deny",
          "etag",
          "groups",
          "limiters",
          "prefixes",
          "profiles",
          "revision",
          "updated",
          "warnings"
        ],
        "type": "object"
      },
      "ProtoPoint": {
        "properties": {
          "icmp": {
            "type": "number"
          },
          "other": {
            "type": "number"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          },
          "tcp": {
            "type": "number"
          },
          "udp": {
            "type": "number"
          }
        },
        "required": [
          "icmp",
          "other",
          "t",
          "tcp",
          "udp"
        ],
        "type": "object"
      },
      "ProtoSeriesResponse": {
        "properties": {
          "from": {
            "format": "date-time",
            "type": "string"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/ProtoPoint"
            },
            "type": "array"
          },
          "res": {
            "type": "string"
          },
          "to": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "from",
          "points",
          "res",
          "to"
        ],
        "type": "object"
      },
      "ProtoView": {
        "properties": {
          "proto": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "proto",
          "stats"
        ],
        "type": "object"
      },
      "Quantiles": {
        "properties": {
          "max": {
            "type": "number"
          },
          "p50": {
            "type": "number"
          },
          "p95": {
            "type": "number"
          },
          "p99": {
            "type": "number"
          }
        },
        "required": [
          "max",
          "p50",
          "p95",
          "p99"
        ],
        "type": "object"
      },
      "QuotaView": {
        "properties": {
          "now_bps": {
            "type": "number"
          },
          "percent": {
            "type": "number"
          },
          "quota_bps": {
            "type": "number"
          },
          "state": {
            "type": "string"
          }
        },
        "required": [
          "now_bps",
          "percent",
          "quota_bps",
          "state"
        ],
        "type": "object"
      },
      "RateSnapshot": {
        "properties": {
          "clean_bps": {
            "type": "number"
          },
          "drop_bps": {
            "type": "number"
          },
          "drop_pps": {
            "type": "number"
          },
          "rx_bps": {
            "type": "number"
          },
          "rx_pps": {
            "type": "number"
          },
          "wd_bps": {
            "type": "number"
          },
          "window_secs": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "clean_bps",
          "drop_bps",
          "drop_pps",
          "rx_bps",
          "rx_pps",
          "wd_bps",
          "window_secs"
        ],
        "type": "object"
      },
      "ReasonStat": {
        "properties": {
          "name": {
            "type": "string"
          },
          "packets": {
            "type": "number"
          },
          "peak_pps": {
            "type": "number"
          }
        },
        "required": [
          "name",
          "packets",
          "peak_pps"
        ],
        "type": "object"
      },
      "Rec": {
        "properties": {
          "c": {
            "type": "string"
          },
          "dp": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "dst": {
            "type": "string"
          },
          "flags": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "len": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "n": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "proto": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "r": {
            "type": "string"
          },
          "sp": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "src": {
            "type": "string"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          },
          "ttl": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "v": {
            "type": "string"
          },
          "w": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "dst",
          "len",
          "proto",
          "src",
          "t",
          "v",
          "w"
        ],
        "type": "object"
      },
      "ReleaseInfo": {
        "properties": {
          "created": {
            "format": "date-time",
            "type": "string"
          },
          "current": {
            "type": "boolean"
          },
          "notes": {
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "created",
          "current",
          "version"
        ],
        "type": "object"
      },
      "RepStat": {
        "properties": {
          "category": {
            "type": "string"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "category",
          "stats"
        ],
        "type": "object"
      },
      "ReportGenerateRequest": {
        "properties": {
          "day": {
            "type": "string"
          },
          "deliver": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "from": {
            "type": "string"
          },
          "incident_id": {
            "type": "string"
          },
          "month": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "sla_target_ms": {
            "format": "int64",
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          },
          "to": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "tz": {
            "type": "string"
          }
        },
        "required": [
          "type"
        ],
        "type": "object"
      },
      "ReportMeta": {
        "properties": {
          "by": {
            "type": "string"
          },
          "bytes": {
            "format": "int64",
            "type": "integer"
          },
          "created": {
            "format": "date-time",
            "type": "string"
          },
          "def": {
            "type": "string"
          },
          "from": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "pages": {
            "format": "int64",
            "type": "integer"
          },
          "period": {
            "type": "string"
          },
          "sha256": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "to": {
            "format": "date-time",
            "type": "string"
          },
          "trigger": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "bytes",
          "created",
          "from",
          "id",
          "name",
          "pages",
          "period",
          "sha256",
          "to",
          "type"
        ],
        "type": "object"
      },
      "RevisionDetail": {
        "properties": {
          "diff": {
            "items": {
              "$ref": "#/components/schemas/Change"
            },
            "type": "array"
          },
          "diff_available": {
            "type": "boolean"
          },
          "parent": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "protection": {
            "$ref": "#/components/schemas/Protection"
          },
          "rev": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rollback_of": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "user": {
            "type": "string"
          }
        },
        "required": [
          "diff",
          "diff_available",
          "parent",
          "protection",
          "rev",
          "sha256",
          "summary",
          "time",
          "user"
        ],
        "type": "object"
      },
      "RevisionList": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/RevisionMeta"
            },
            "type": "array"
          },
          "next": {
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "items",
          "next"
        ],
        "type": "object"
      },
      "RevisionMeta": {
        "properties": {
          "parent": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rev": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rollback_of": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sha256": {
            "type": "string"
          },
          "summary": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          },
          "user": {
            "type": "string"
          }
        },
        "required": [
          "parent",
          "rev",
          "sha256",
          "summary",
          "time",
          "user"
        ],
        "type": "object"
      },
      "RoutedConfig": {
        "properties": {
          "bfd": {
            "allOf": [
              {
                "$ref": "#/components/schemas/BFD"
              }
            ],
            "nullable": true
          },
          "downstream": {
            "$ref": "#/components/schemas/Port"
          },
          "enabled": {
            "type": "boolean"
          },
          "forward_unprotected": {
            "type": "boolean"
          },
          "maintenance": {
            "type": "boolean"
          },
          "next_hop": {
            "type": "string"
          },
          "return_via_upstream": {
            "type": "boolean"
          },
          "upstream": {
            "$ref": "#/components/schemas/Port"
          },
          "upstream_peer": {
            "type": "string"
          }
        },
        "required": [
          "downstream",
          "enabled",
          "next_hop",
          "upstream"
        ],
        "type": "object"
      },
      "RoutedStatus": {
        "properties": {
          "downstream_up": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "forward_unprotected": {
            "type": "boolean"
          },
          "last_error": {
            "type": "string"
          },
          "next_hop_ok": {
            "type": "boolean"
          },
          "prefixes": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "return_path": {
            "type": "boolean"
          },
          "routes": {
            "format": "int64",
            "type": "integer"
          },
          "updated": {
            "format": "date-time",
            "type": "string"
          },
          "upstream_up": {
            "type": "boolean"
          }
        },
        "required": [
          "downstream_up",
          "enabled",
          "forward_unprotected",
          "next_hop_ok",
          "prefixes",
          "return_path",
          "routes",
          "updated",
          "upstream_up"
        ],
        "type": "object"
      },
      "RoutedView": {
        "properties": {
          "config": {
            "$ref": "#/components/schemas/RoutedConfig"
          },
          "status": {
            "$ref": "#/components/schemas/RoutedStatus"
          }
        },
        "required": [
          "config",
          "status"
        ],
        "type": "object"
      },
      "RuleHit": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "index": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "drop_packets",
          "index",
          "name",
          "packets"
        ],
        "type": "object"
      },
      "RuleInfo": {
        "properties": {
          "action": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "flags": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "index": {
            "format": "int64",
            "type": "integer"
          },
          "limiter": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "match": {
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "stats": {
            "$ref": "#/components/schemas/Stats"
          }
        },
        "required": [
          "action",
          "flags",
          "index",
          "limiter",
          "match",
          "profile",
          "stats"
        ],
        "type": "object"
      },
      "Schedule": {
        "properties": {
          "day": {
            "format": "int64",
            "type": "integer"
          },
          "hour": {
            "format": "int64",
            "type": "integer"
          },
          "kind": {
            "type": "string"
          },
          "tz": {
            "type": "string"
          },
          "weekday": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "kind"
        ],
        "type": "object"
      },
      "ScheduleChange": {
        "properties": {
          "applied": {
            "type": "boolean"
          },
          "definition": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Definition"
              }
            ],
            "nullable": true
          },
          "rev": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "applied",
          "rev"
        ],
        "type": "object"
      },
      "ScheduleInfo": {
        "properties": {
          "deliver": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "enabled": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "last_run": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "next_run": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "schedule": {
            "$ref": "#/components/schemas/Schedule"
          },
          "sla_target_ms": {
            "format": "int64",
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "enabled",
          "id",
          "name",
          "schedule",
          "type"
        ],
        "type": "object"
      },
      "SelfProtCounter": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "wd_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "wd_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "drop_bytes",
          "drop_packets",
          "packets",
          "wd_bytes",
          "wd_packets"
        ],
        "type": "object"
      },
      "SelfProtRuleView": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "implicit": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "slot": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "implicit",
          "packets",
          "slot"
        ],
        "type": "object"
      },
      "SelfProtSeenView": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "family": {
            "format": "int64",
            "type": "integer"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "port": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "proto": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "proto_name": {
            "type": "string"
          },
          "suggested_rule": {
            "type": "string"
          }
        },
        "required": [
          "bytes",
          "family",
          "packets",
          "port",
          "proto",
          "proto_name"
        ],
        "type": "object"
      },
      "SelfProtStatus": {
        "properties": {
          "addresses": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "configured": {
            "type": "boolean"
          },
          "expired": {
            "type": "boolean"
          },
          "icmp_echo_limited": {
            "type": "boolean"
          },
          "mode": {
            "type": "string"
          },
          "pending_by": {
            "type": "string"
          },
          "pending_confirm_s": {
            "type": "number"
          },
          "rules": {
            "items": {
              "$ref": "#/components/schemas/SelfProtRuleView"
            },
            "type": "array"
          },
          "source_set_entries": {
            "format": "int64",
            "type": "integer"
          },
          "stats": {
            "additionalProperties": {
              "$ref": "#/components/schemas/SelfProtCounter"
            },
            "type": "object"
          }
        },
        "required": [
          "addresses",
          "configured",
          "icmp_echo_limited",
          "mode",
          "rules",
          "source_set_entries",
          "stats"
        ],
        "type": "object"
      },
      "Series": {
        "properties": {
          "classes": {
            "items": {
              "$ref": "#/components/schemas/ClassStat"
            },
            "type": "array"
          },
          "end": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "partial": {
            "type": "boolean"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/AttackseriesPoint"
            },
            "type": "array"
          },
          "prefix": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "reasons": {
            "items": {
              "$ref": "#/components/schemas/ReasonStat"
            },
            "type": "array"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "step_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "points",
          "prefix",
          "prefix_id",
          "start",
          "step_s"
        ],
        "type": "object"
      },
      "SeriesPoint": {
        "properties": {
          "clean_bps": {
            "type": "number"
          },
          "drop_bps": {
            "type": "number"
          },
          "drop_pps": {
            "type": "number"
          },
          "rx_bps": {
            "type": "number"
          },
          "rx_pps": {
            "type": "number"
          },
          "t": {
            "format": "int64",
            "type": "integer"
          },
          "wd_bps": {
            "type": "number"
          }
        },
        "required": [
          "clean_bps",
          "drop_bps",
          "drop_pps",
          "rx_bps",
          "rx_pps",
          "t",
          "wd_bps"
        ],
        "type": "object"
      },
      "SeriesResponse": {
        "properties": {
          "from": {
            "format": "date-time",
            "type": "string"
          },
          "points": {
            "items": {
              "$ref": "#/components/schemas/SeriesPoint"
            },
            "type": "array"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "nullable": true,
            "type": "integer"
          },
          "res": {
            "type": "string"
          },
          "to": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "from",
          "points",
          "res",
          "to"
        ],
        "type": "object"
      },
      "SessionSettings": {
        "properties": {
          "idle_minutes": {
            "format": "int64",
            "type": "integer"
          },
          "max_hours": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "idle_minutes",
          "max_hours"
        ],
        "type": "object"
      },
      "SetPasswordRequest": {
        "properties": {
          "must_change": {
            "nullable": true,
            "type": "boolean"
          },
          "password": {
            "type": "string"
          }
        },
        "required": [
          "must_change",
          "password"
        ],
        "type": "object"
      },
      "Share": {
        "properties": {
          "est_pps": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "share": {
            "type": "number"
          }
        },
        "required": [
          "est_pps",
          "name",
          "share"
        ],
        "type": "object"
      },
      "State": {
        "properties": {
          "autoneg": {
            "type": "boolean"
          },
          "fec_active": {
            "type": "string"
          },
          "fec_configured": {
            "type": "string"
          },
          "link": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "speed_mbps": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "autoneg",
          "link",
          "name",
          "speed_mbps"
        ],
        "type": "object"
      },
      "Stats": {
        "properties": {
          "bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "wd_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "wd_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "bytes",
          "drop_bytes",
          "drop_packets",
          "packets",
          "wd_bytes",
          "wd_packets"
        ],
        "type": "object"
      },
      "SuggestReport": {
        "properties": {
          "attack_samples": {
            "format": "int64",
            "type": "integer"
          },
          "attack_weight": {
            "type": "number"
          },
          "notes": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "pass_samples": {
            "format": "int64",
            "type": "integer"
          },
          "pass_weight": {
            "type": "number"
          },
          "suggestions": {
            "items": {
              "$ref": "#/components/schemas/Suggestion"
            },
            "type": "array"
          }
        },
        "required": [
          "attack_samples",
          "attack_weight",
          "pass_samples",
          "pass_weight",
          "suggestions"
        ],
        "type": "object"
      },
      "Suggestion": {
        "properties": {
          "attack_samples": {
            "format": "int64",
            "type": "integer"
          },
          "collateral": {
            "type": "number"
          },
          "coverage": {
            "type": "number"
          },
          "pass_samples": {
            "format": "int64",
            "type": "integer"
          },
          "rationale": {
            "type": "string"
          },
          "recommended": {
            "type": "string"
          },
          "risk": {
            "type": "string"
          },
          "rule": {
            "$ref": "#/components/schemas/ConfigRule"
          },
          "total_coverage": {
            "type": "number"
          }
        },
        "required": [
          "attack_samples",
          "collateral",
          "coverage",
          "pass_samples",
          "rationale",
          "recommended",
          "risk",
          "rule",
          "total_coverage"
        ],
        "type": "object"
      },
      "SuggestionsView": {
        "properties": {
          "incident_id": {
            "type": "string"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "profile_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "report": {
            "$ref": "#/components/schemas/SuggestReport"
          }
        },
        "required": [
          "incident_id",
          "prefix_id",
          "profile_id",
          "report"
        ],
        "type": "object"
      },
      "SynAuth": {
        "properties": {
          "drop_nonsyn": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "validity_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "drop_nonsyn",
          "enabled",
          "validity_s"
        ],
        "type": "object"
      },
      "SynAuthInfo": {
        "properties": {
          "SecretSet": {
            "type": "boolean"
          },
          "Total4": {
            "format": "int64",
            "type": "integer"
          },
          "Total6": {
            "format": "int64",
            "type": "integer"
          },
          "Validated4": {
            "format": "int64",
            "type": "integer"
          },
          "Validated6": {
            "format": "int64",
            "type": "integer"
          },
          "WindowNS": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "SecretSet",
          "Total4",
          "Total6",
          "Validated4",
          "Validated6",
          "WindowNS"
        ],
        "type": "object"
      },
      "SystemHealthResponse": {
        "properties": {
          "audit": {
            "$ref": "#/components/schemas/AuditInfo"
          },
          "host": {
            "$ref": "#/components/schemas/SystemHost"
          },
          "telemetry": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TelemetryStatus"
              }
            ],
            "nullable": true
          },
          "tls": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TlsutilCertInfo"
              }
            ],
            "nullable": true
          },
          "wsd": {
            "$ref": "#/components/schemas/WsdInfo"
          }
        },
        "required": [
          "audit",
          "host",
          "telemetry",
          "tls",
          "wsd"
        ],
        "type": "object"
      },
      "SystemHistory": {
        "properties": {
          "points": {
            "items": {
              "$ref": "#/components/schemas/HistPoint"
            },
            "type": "array"
          },
          "step_secs": {
            "format": "int64",
            "type": "integer"
          },
          "window_secs": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "points",
          "step_secs",
          "window_secs"
        ],
        "type": "object"
      },
      "SystemHost": {
        "properties": {
          "bmc": {
            "type": "string"
          },
          "cores": {
            "items": {
              "$ref": "#/components/schemas/CpuCore"
            },
            "type": "array"
          },
          "cpus": {
            "items": {
              "$ref": "#/components/schemas/CpuPackage"
            },
            "type": "array"
          },
          "disk_free": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "disk_total": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "fans": {
            "items": {
              "$ref": "#/components/schemas/Fan"
            },
            "type": "array"
          },
          "hostname": {
            "type": "string"
          },
          "hw": {
            "$ref": "#/components/schemas/Hardware"
          },
          "kernel": {
            "type": "string"
          },
          "load1": {
            "type": "number"
          },
          "load15": {
            "type": "number"
          },
          "load5": {
            "type": "number"
          },
          "mem_available": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "mem_total": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "os_version": {
            "type": "string"
          },
          "power_w": {
            "type": "number"
          },
          "psus": {
            "items": {
              "$ref": "#/components/schemas/PSU"
            },
            "type": "array"
          },
          "temps": {
            "items": {
              "$ref": "#/components/schemas/TempSensor"
            },
            "type": "array"
          },
          "uptime_s": {
            "type": "number"
          }
        },
        "required": [
          "cores",
          "cpus",
          "disk_free",
          "disk_total",
          "fans",
          "hostname",
          "hw",
          "kernel",
          "load1",
          "load15",
          "load5",
          "mem_available",
          "mem_total",
          "temps",
          "uptime_s"
        ],
        "type": "object"
      },
      "TIEntryRequest": {
        "properties": {
          "category": {
            "type": "string"
          },
          "cidr": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "ttl_s": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "cidr"
        ],
        "type": "object"
      },
      "TIFeedRequest": {
        "properties": {
          "category": {
            "type": "string"
          },
          "enabled": {
            "nullable": true,
            "type": "boolean"
          },
          "interval_s": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "category",
          "name",
          "url"
        ],
        "type": "object"
      },
      "TILookupView": {
        "properties": {
          "ip": {
            "type": "string"
          },
          "matches": {
            "items": {
              "$ref": "#/components/schemas/TiMatch"
            },
            "type": "array"
          }
        },
        "required": [
          "ip",
          "matches"
        ],
        "type": "object"
      },
      "TIStatusView": {
        "properties": {
          "age_s": {
            "type": "number"
          },
          "applied_at": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "created": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "effective": {
            "format": "int64",
            "type": "integer"
          },
          "entries": {
            "additionalProperties": {
              "format": "int64",
              "type": "integer"
            },
            "type": "object"
          },
          "feed": {
            "type": "string"
          },
          "key_id": {
            "type": "string"
          },
          "last_reject": {
            "type": "string"
          },
          "own": {
            "format": "int64",
            "type": "integer"
          },
          "rejected": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "seq": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "stale": {
            "type": "boolean"
          },
          "traffic": {
            "items": {
              "$ref": "#/components/schemas/RepStat"
            },
            "type": "array"
          },
          "trusted_keys": {
            "format": "int64",
            "type": "integer"
          },
          "url_feed_entries": {
            "format": "int64",
            "type": "integer"
          },
          "url_feeds": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "age_s",
          "effective",
          "entries",
          "feed",
          "own",
          "rejected",
          "seq",
          "stale",
          "traffic",
          "trusted_keys",
          "url_feed_entries",
          "url_feeds"
        ],
        "type": "object"
      },
      "TelemetryStatus": {
        "properties": {
          "adaptive_adjustments": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "adaptive_enabled": {
            "type": "boolean"
          },
          "adaptive_max_rate": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "adaptive_min_rate": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "adaptive_target_samples_per_sec": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "decode_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "disk_bytes": {
            "format": "int64",
            "type": "integer"
          },
          "disk_enabled": {
            "type": "boolean"
          },
          "disk_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "disk_segments": {
            "format": "int64",
            "type": "integer"
          },
          "kernel_sample_lost": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "kernel_sampled": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "prefix_states": {
            "format": "int64",
            "type": "integer"
          },
          "read_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sample_rate": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "samples_processed": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "samples_rejected": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "adaptive_adjustments",
          "adaptive_enabled",
          "adaptive_max_rate",
          "adaptive_min_rate",
          "adaptive_target_samples_per_sec",
          "decode_errors",
          "disk_bytes",
          "disk_enabled",
          "disk_errors",
          "disk_segments",
          "kernel_sample_lost",
          "kernel_sampled",
          "prefix_states",
          "read_errors",
          "sample_rate",
          "samples_processed",
          "samples_rejected"
        ],
        "type": "object"
      },
      "TempSensor": {
        "properties": {
          "celsius": {
            "type": "number"
          },
          "sensor": {
            "type": "string"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "celsius",
          "sensor"
        ],
        "type": "object"
      },
      "Template": {
        "properties": {
          "description": {
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "limiters": {
            "items": {
              "$ref": "#/components/schemas/Limiter"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          },
          "profile": {
            "$ref": "#/components/schemas/Profile"
          }
        },
        "required": [
          "description",
          "id",
          "name",
          "profile"
        ],
        "type": "object"
      },
      "TemplateList": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Template"
            },
            "type": "array"
          }
        },
        "required": [
          "items"
        ],
        "type": "object"
      },
      "TenantPrefix": {
        "properties": {
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "managed": {
            "type": "boolean"
          },
          "mode": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "managed",
          "mode",
          "prefix"
        ],
        "type": "object"
      },
      "TenantView": {
        "properties": {
          "active_attacks": {
            "format": "int64",
            "type": "integer"
          },
          "auth_prefixes": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "can_edit_lists": {
            "type": "boolean"
          },
          "can_edit_rules": {
            "type": "boolean"
          },
          "can_set_mode": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "list_limit": {
            "format": "int64",
            "type": "integer"
          },
          "managed": {
            "type": "boolean"
          },
          "max_prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "plan": {
            "type": "string"
          },
          "prefixes": {
            "items": {
              "$ref": "#/components/schemas/TenantPrefix"
            },
            "type": "array"
          },
          "quota": {
            "$ref": "#/components/schemas/QuotaView"
          },
          "rule_limit": {
            "format": "int64",
            "type": "integer"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "active_attacks",
          "auth_prefixes",
          "can_edit_lists",
          "can_edit_rules",
          "can_set_mode",
          "id",
          "list_limit",
          "managed",
          "max_prefixes",
          "name",
          "plan",
          "prefixes",
          "quota",
          "rule_limit",
          "status"
        ],
        "type": "object"
      },
      "TerminateRequest": {
        "properties": {
          "relearn": {
            "type": "boolean"
          }
        },
        "type": "object"
      },
      "TiMatch": {
        "properties": {
          "category": {
            "type": "string"
          },
          "comment": {
            "type": "string"
          },
          "expires": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "source": {
            "type": "string"
          }
        },
        "required": [
          "category",
          "prefix",
          "source"
        ],
        "type": "object"
      },
      "TlsutilCertInfo": {
        "properties": {
          "dns_names": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "expired": {
            "type": "boolean"
          },
          "fingerprint": {
            "type": "string"
          },
          "ips": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "not_after": {
            "format": "date-time",
            "type": "string"
          },
          "not_before": {
            "format": "date-time",
            "type": "string"
          },
          "self_signed": {
            "type": "boolean"
          },
          "subject": {
            "type": "string"
          }
        },
        "required": [
          "dns_names",
          "expired",
          "fingerprint",
          "ips",
          "not_after",
          "not_before",
          "self_signed",
          "subject"
        ],
        "type": "object"
      },
      "TokenInfo": {
        "properties": {
          "cidrs": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "created": {
            "format": "date-time",
            "type": "string"
          },
          "expires": {
            "format": "date-time",
            "type": "string"
          },
          "id": {
            "type": "string"
          },
          "last_used": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "read_only": {
            "type": "boolean"
          },
          "user": {
            "type": "string"
          }
        },
        "required": [
          "created",
          "expires",
          "id",
          "name",
          "read_only",
          "user"
        ],
        "type": "object"
      },
      "TopEntry": {
        "properties": {
          "cc": {
            "type": "string"
          },
          "est_pps": {
            "type": "number"
          },
          "key": {
            "type": "string"
          },
          "max_err_pps": {
            "type": "number"
          },
          "share": {
            "type": "number"
          }
        },
        "required": [
          "est_pps",
          "key",
          "max_err_pps",
          "share"
        ],
        "type": "object"
      },
      "TopResponse": {
        "properties": {
          "available": {
            "type": "boolean"
          },
          "sample_rate": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "snapshot": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TopSnapshot"
              }
            ],
            "nullable": true
          }
        },
        "required": [
          "available",
          "sample_rate"
        ],
        "type": "object"
      },
      "TopSnapshot": {
        "properties": {
          "asns": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "classes": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "complete": {
            "type": "boolean"
          },
          "countries": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "distinct_sources_est": {
            "type": "number"
          },
          "dst_ports": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "est_bps": {
            "type": "number"
          },
          "est_pps": {
            "type": "number"
          },
          "estimated": {
            "type": "boolean"
          },
          "prefix_id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "prefixes": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "protocols": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "reasons": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "samples": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "sizes": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "source_nets": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "sources": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "src_ports": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "targets": {
            "items": {
              "$ref": "#/components/schemas/TopEntry"
            },
            "type": "array"
          },
          "tcp_flags": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "verdicts": {
            "items": {
              "$ref": "#/components/schemas/Share"
            },
            "type": "array"
          },
          "window_secs": {
            "type": "number"
          },
          "window_start": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "classes",
          "complete",
          "distinct_sources_est",
          "dst_ports",
          "est_bps",
          "est_pps",
          "estimated",
          "prefix_id",
          "protocols",
          "reasons",
          "samples",
          "sizes",
          "source_nets",
          "sources",
          "src_ports",
          "targets",
          "tcp_flags",
          "verdicts",
          "window_secs",
          "window_start"
        ],
        "type": "object"
      },
      "Tunnel": {
        "properties": {
          "bgp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TunnelBGP"
              }
            ],
            "nullable": true
          },
          "comment": {
            "type": "string"
          },
          "disabled": {
            "type": "boolean"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "inner_local": {
            "type": "string"
          },
          "inner_peer": {
            "type": "string"
          },
          "key": {
            "format": "int32",
            "minimum": 0,
            "nullable": true,
            "type": "integer"
          },
          "local": {
            "type": "string"
          },
          "mss_clamp": {
            "nullable": true,
            "type": "boolean"
          },
          "mtu": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "no_probe": {
            "type": "boolean"
          },
          "remote": {
            "type": "string"
          },
          "routes": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "tenant": {
            "type": "string"
          },
          "ttl": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "id",
          "local",
          "name",
          "remote",
          "tenant"
        ],
        "type": "object"
      },
      "TunnelBGP": {
        "properties": {
          "as_set": {
            "type": "string"
          },
          "asn": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "disabled": {
            "type": "boolean"
          },
          "group": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "irr": {
            "type": "string"
          },
          "max_len_v4": {
            "format": "int64",
            "type": "integer"
          },
          "max_len_v6": {
            "format": "int64",
            "type": "integer"
          },
          "max_prefixes": {
            "format": "int64",
            "type": "integer"
          },
          "mode": {
            "type": "string"
          },
          "profile": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "rpki": {
            "type": "string"
          }
        },
        "required": [
          "asn"
        ],
        "type": "object"
      },
      "TunnelHealthView": {
        "properties": {
          "bgp": {
            "type": "string"
          },
          "error": {
            "type": "string"
          },
          "failures": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "last_ok": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "last_rtt_ms": {
            "type": "number"
          },
          "loss_pct": {
            "type": "number"
          },
          "overall": {
            "type": "string"
          },
          "probe": {
            "type": "string"
          },
          "probes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "reason": {
            "type": "string"
          },
          "rtt_ms": {
            "type": "number"
          },
          "since": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          }
        },
        "required": [
          "failures",
          "last_rtt_ms",
          "loss_pct",
          "overall",
          "probe",
          "probes",
          "rtt_ms"
        ],
        "type": "object"
      },
      "TunnelLive": {
        "properties": {
          "addrs": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "error": {
            "type": "string"
          },
          "health": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TunnelHealthView"
              }
            ],
            "nullable": true
          },
          "ifname": {
            "type": "string"
          },
          "last_action": {
            "type": "string"
          },
          "mtu": {
            "format": "int64",
            "type": "integer"
          },
          "oper_up": {
            "type": "boolean"
          },
          "present": {
            "type": "boolean"
          },
          "rx_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "rx_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_dropped": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_errors": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "tx_packets": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "up": {
            "type": "boolean"
          }
        },
        "required": [
          "addrs",
          "ifname",
          "mtu",
          "oper_up",
          "present",
          "rx_bytes",
          "rx_dropped",
          "rx_errors",
          "rx_packets",
          "tx_bytes",
          "tx_dropped",
          "tx_errors",
          "tx_packets",
          "up"
        ],
        "type": "object"
      },
      "TunnelSystem": {
        "properties": {
          "clamp_error": {
            "type": "string"
          },
          "errors": {
            "format": "int64",
            "type": "integer"
          },
          "ip_forward": {
            "type": "boolean"
          },
          "oper_up": {
            "format": "int64",
            "type": "integer"
          },
          "present": {
            "format": "int64",
            "type": "integer"
          },
          "tunnels": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "errors",
          "ip_forward",
          "oper_up",
          "present",
          "tunnels"
        ],
        "type": "object"
      },
      "TunnelView": {
        "properties": {
          "bgp": {
            "allOf": [
              {
                "$ref": "#/components/schemas/TunnelBGP"
              }
            ],
            "nullable": true
          },
          "comment": {
            "type": "string"
          },
          "disabled": {
            "type": "boolean"
          },
          "id": {
            "format": "int32",
            "minimum": 0,
            "type": "integer"
          },
          "inner_local": {
            "type": "string"
          },
          "inner_peer": {
            "type": "string"
          },
          "key": {
            "format": "int32",
            "minimum": 0,
            "nullable": true,
            "type": "integer"
          },
          "live": {
            "$ref": "#/components/schemas/TunnelLive"
          },
          "local": {
            "type": "string"
          },
          "mss_clamp": {
            "type": "boolean"
          },
          "mtu": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "no_probe": {
            "type": "boolean"
          },
          "remote": {
            "type": "string"
          },
          "routes": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "tenant": {
            "type": "string"
          },
          "ttl": {
            "format": "int64",
            "type": "integer"
          }
        },
        "required": [
          "disabled",
          "id",
          "live",
          "local",
          "mss_clamp",
          "mtu",
          "name",
          "no_probe",
          "remote",
          "routes",
          "tenant",
          "ttl"
        ],
        "type": "object"
      },
      "URLFeedPatch": {
        "properties": {
          "category": {
            "nullable": true,
            "type": "string"
          },
          "enabled": {
            "nullable": true,
            "type": "boolean"
          },
          "interval_s": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "name": {
            "nullable": true,
            "type": "string"
          },
          "url": {
            "nullable": true,
            "type": "string"
          }
        },
        "type": "object"
      },
      "URLFeedView": {
        "properties": {
          "category": {
            "type": "string"
          },
          "enabled": {
            "type": "boolean"
          },
          "entries": {
            "format": "int64",
            "type": "integer"
          },
          "fetching": {
            "type": "boolean"
          },
          "id": {
            "type": "string"
          },
          "interval_s": {
            "format": "int64",
            "type": "integer"
          },
          "last_attempt": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "last_error": {
            "type": "string"
          },
          "last_success": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "next_due": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "skipped": {
            "format": "int64",
            "type": "integer"
          },
          "url": {
            "type": "string"
          }
        },
        "required": [
          "category",
          "enabled",
          "entries",
          "fetching",
          "id",
          "interval_s",
          "name",
          "skipped",
          "url"
        ],
        "type": "object"
      },
      "UpdatePending": {
        "properties": {
          "boots": {
            "format": "int64",
            "type": "integer"
          },
          "deadline": {
            "format": "date-time",
            "type": "string"
          },
          "from": {
            "type": "string"
          },
          "since": {
            "format": "date-time",
            "type": "string"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "boots",
          "deadline",
          "from",
          "since",
          "version"
        ],
        "type": "object"
      },
      "UpdateStatus": {
        "properties": {
          "account_id": {
            "type": "string"
          },
          "configured": {
            "type": "boolean"
          },
          "enabled": {
            "type": "boolean"
          },
          "failures": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "interval_h": {
            "format": "int64",
            "type": "integer"
          },
          "key_set": {
            "type": "boolean"
          },
          "last_attempt": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "last_error": {
            "type": "string"
          },
          "last_success": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "next": {
            "format": "date-time",
            "nullable": true,
            "type": "string"
          },
          "running": {
            "type": "boolean"
          },
          "version": {
            "type": "string"
          }
        },
        "required": [
          "configured",
          "enabled",
          "failures",
          "interval_h",
          "key_set",
          "running"
        ],
        "type": "object"
      },
      "UpdateView": {
        "properties": {
          "current": {
            "type": "string"
          },
          "failed": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "history": {
            "items": {
              "$ref": "#/components/schemas/Event"
            },
            "type": "array"
          },
          "pending": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UpdatePending"
              }
            ],
            "nullable": true
          },
          "previous": {
            "type": "string"
          },
          "releases": {
            "items": {
              "$ref": "#/components/schemas/ReleaseInfo"
            },
            "type": "array"
          }
        },
        "required": [
          "current",
          "history",
          "releases"
        ],
        "type": "object"
      },
      "UsageReport": {
        "properties": {
          "clean_tb": {
            "type": "number"
          },
          "from": {
            "format": "date-time",
            "type": "string"
          },
          "generated": {
            "format": "date-time",
            "type": "string"
          },
          "month": {
            "type": "string"
          },
          "tenants": {
            "items": {
              "$ref": "#/components/schemas/UsageTenantReport"
            },
            "type": "array"
          },
          "to": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "clean_tb",
          "from",
          "generated",
          "month",
          "tenants",
          "to"
        ],
        "type": "object"
      },
      "UsageSample": {
        "properties": {
          "clean_bps_avg": {
            "type": "number"
          },
          "clean_bps_peak": {
            "type": "number"
          },
          "clean_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "drop_bps_peak": {
            "type": "number"
          },
          "drop_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "partial": {
            "type": "boolean"
          },
          "seconds": {
            "type": "number"
          },
          "start": {
            "format": "date-time",
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "total_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "clean_bps_avg",
          "clean_bps_peak",
          "clean_bytes",
          "drop_bps_peak",
          "drop_bytes",
          "seconds",
          "start",
          "tenant",
          "total_bytes"
        ],
        "type": "object"
      },
      "UsageTenantReport": {
        "properties": {
          "attack_seconds": {
            "type": "number"
          },
          "attacks": {
            "format": "int64",
            "type": "integer"
          },
          "avg_clean_bps": {
            "type": "number"
          },
          "clean_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "clean_tb": {
            "type": "number"
          },
          "drop_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "p95_clean_bps": {
            "type": "number"
          },
          "peak_clean_bps": {
            "type": "number"
          },
          "plan": {
            "type": "string"
          },
          "quota_bps": {
            "type": "number"
          },
          "quota_exceeded_samples": {
            "format": "int64",
            "type": "integer"
          },
          "samples": {
            "format": "int64",
            "type": "integer"
          },
          "tenant": {
            "type": "string"
          },
          "total_bytes": {
            "format": "int64",
            "minimum": 0,
            "type": "integer"
          }
        },
        "required": [
          "attack_seconds",
          "attacks",
          "avg_clean_bps",
          "clean_bytes",
          "clean_tb",
          "drop_bytes",
          "name",
          "p95_clean_bps",
          "peak_clean_bps",
          "plan",
          "quota_bps",
          "quota_exceeded_samples",
          "samples",
          "tenant",
          "total_bytes"
        ],
        "type": "object"
      },
      "UserPatch": {
        "properties": {
          "role": {
            "nullable": true,
            "type": "string"
          },
          "tenant": {
            "nullable": true,
            "type": "string"
          },
          "unix_user": {
            "nullable": true,
            "type": "string"
          },
          "web": {
            "nullable": true,
            "type": "boolean"
          }
        },
        "required": [
          "role",
          "tenant",
          "unix_user",
          "web"
        ],
        "type": "object"
      },
      "UserRequest": {
        "properties": {
          "must_change": {
            "nullable": true,
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "password": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "uid": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "unix_user": {
            "type": "string"
          },
          "web": {
            "type": "boolean"
          }
        },
        "required": [
          "must_change",
          "name",
          "password",
          "role",
          "tenant",
          "uid",
          "unix_user",
          "web"
        ],
        "type": "object"
      },
      "UserView": {
        "properties": {
          "auth": {
            "allOf": [
              {
                "$ref": "#/components/schemas/AuthStatus"
              }
            ],
            "nullable": true
          },
          "managed": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "role": {
            "type": "string"
          },
          "tenant": {
            "type": "string"
          },
          "uid": {
            "format": "int64",
            "nullable": true,
            "type": "integer"
          },
          "unix_user": {
            "type": "string"
          },
          "web": {
            "type": "boolean"
          }
        },
        "required": [
          "managed",
          "name",
          "role",
          "web"
        ],
        "type": "object"
      },
      "Would": {
        "properties": {
          "kind": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          },
          "target": {
            "type": "string"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "kind",
          "target",
          "time"
        ],
        "type": "object"
      },
      "WsdInfo": {
        "properties": {
          "interface": {
            "type": "string"
          },
          "started": {
            "format": "date-time",
            "type": "string"
          },
          "uptime_s": {
            "type": "number"
          },
          "version": {
            "type": "string"
          },
          "xdp_mode": {
            "type": "string"
          }
        },
        "required": [
          "interface",
          "started",
          "uptime_s",
          "version",
          "xdp_mode"
        ],
        "type": "object"
      }
    },
    "securitySchemes": {
      "bearer": {
        "description": "API token (wsk_…) created in the panel: user menu → API tokens",
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "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.",
    "title": "WireShield MSSP API",
    "version": "1.0.30"
  },
  "openapi": "3.0.3",
  "paths": {
    "/metrics": {
      "get": {
        "operationId": "getMetrics",
        "responses": {
          "200": {
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "500": {
            "description": "Data plane counters could not be read (Prometheus sees up=0)"
          }
        },
        "summary": "Prometheus metrics (text format 0.0.4); not available to the tenant role. Authentication: Bearer token (read-only recommended)",
        "tags": [
          "System"
        ],
        "x-required-permission": "metrics:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/ackval": {
      "get": {
        "operationId": "getAckval",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AckInfo"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "ACK/RST validation: counts of learned (handshake observed) and pending sources",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/attacks": {
      "get": {
        "operationId": "getAttacks",
        "parameters": [
          {
            "in": "query",
            "name": "n",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/AttackRecord"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Attack events (tenant: own prefixes only)",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "attack:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/auth/tokens": {
      "get": {
        "operationId": "getAuthTokens",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/TokenInfo"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "My tokens",
        "tags": [
          "Authentication"
        ],
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/bgp/prefixes": {
      "get": {
        "operationId": "getBgpPrefixes",
        "parameters": [
          {
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "tunnel",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "prefix",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/BGPPrefixView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid filter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "BGP is not enabled on this appliance"
          }
        },
        "summary": "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",
        "tags": [
          "BGP"
        ],
        "x-required-permission": "bgp:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/bgp/refresh": {
      "post": {
        "operationId": "postBgpRefresh",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "IRR is not configured"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "BGP is not enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "BGP"
        ],
        "x-audited": true,
        "x-required-permission": "bgp:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/bgp/sessions": {
      "get": {
        "operationId": "getBgpSessions",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/BGPSessionView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "BGP is not enabled on this appliance"
          }
        },
        "summary": "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",
        "tags": [
          "BGP"
        ],
        "x-required-permission": "bgp:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/bgp/sessions/{tunnel}/reset": {
      "post": {
        "operationId": "postBgpSessionsByTunnelReset",
        "parameters": [
          {
            "in": "path",
            "name": "tunnel",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tunnel or session not found"
          },
          "409": {
            "description": "Engine could not reset"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "BGP is not enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Reset the tunnel's customer BGP session (admin/operator). That customer's prefixes are withdrawn until the session is re-established",
        "tags": [
          "BGP"
        ],
        "x-audited": true,
        "x-required-permission": "bgp:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/bgp/status": {
      "get": {
        "operationId": "getBgpStatus",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BGPStatusView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "BGP is not enabled on this appliance"
          }
        },
        "summary": "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",
        "tags": [
          "BGP"
        ],
        "x-required-permission": "bgp:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/captures": {
      "get": {
        "operationId": "getCaptures",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CaptureList"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Capture not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          }
        },
        "summary": "Captures (newest first; running ones with live counters)",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "capture:read",
        "x-roles": [
          "operator"
        ]
      },
      "post": {
        "operationId": "postCaptures",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CaptureRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PcapMeta"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid duration/filter/verdict/limit"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found"
          },
          "409": {
            "description": "A capture is already running for this prefix, or the concurrency limit is reached"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Forensics"
        ],
        "x-audited": true,
        "x-required-permission": "capture:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/captures/{id}": {
      "delete": {
        "operationId": "deleteCapturesById",
        "parameters": [
          {
            "description": "capture ID (cap-\u003cprefix_id\u003e-\u003cunix_ms\u003e)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Capture not found"
          },
          "409": {
            "description": "Capture is running: stop it first"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a finished capture (a running one cannot be deleted). An audit record is written",
        "tags": [
          "Forensics"
        ],
        "x-audited": true,
        "x-required-permission": "capture:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getCapturesById",
        "parameters": [
          {
            "description": "capture ID (cap-\u003cprefix_id\u003e-\u003cunix_ms\u003e)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PcapMeta"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Capture not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          }
        },
        "summary": "Capture summary: state (running|done|stopped|limit|failed|interrupted), packets/bytes, filtered out, user rate limit, kernel drops",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "capture:read",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/captures/{id}/pcap": {
      "get": {
        "operationId": "getCapturesByIdPcap",
        "parameters": [
          {
            "description": "capture ID (cap-\u003cprefix_id\u003e-\u003cunix_ms\u003e)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.tcpdump.pcap": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Capture not found"
          },
          "409": {
            "description": "Capture is running"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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)",
        "tags": [
          "Forensics"
        ],
        "x-audited": true,
        "x-required-permission": "capture:read",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/captures/{id}/stop": {
      "post": {
        "operationId": "postCapturesByIdStop",
        "parameters": [
          {
            "description": "capture ID (cap-\u003cprefix_id\u003e-\u003cunix_ms\u003e)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PcapMeta"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Capture not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "PCAP capture is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Stop a running capture (returns the summary if already finished). An audit record is written",
        "tags": [
          "Forensics"
        ],
        "x-audited": true,
        "x-required-permission": "capture:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/classes": {
      "get": {
        "operationId": "getClasses",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ClassView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Per-prefix traffic class counters",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/counters": {
      "get": {
        "operationId": "getCounters",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Counters"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Global counters and drop reasons",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/escalations": {
      "get": {
        "operationId": "getEscalations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/EscalationView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          }
        },
        "summary": "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",
        "tags": [
          "Upstream mitigation"
        ],
        "x-required-permission": "escalation:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postEscalations",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EscalationRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscalationView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tenant not found / not within any tenant's space"
          },
          "409": {
            "description": "Multiple tenant spaces match"
          },
          "422": {
            "description": "Validation error (reasons in `problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Upstream mitigation"
        ],
        "x-audited": true,
        "x-required-permission": "escalation:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/escalations/{id}": {
      "delete": {
        "operationId": "deleteEscalationsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Entry not found"
          },
          "409": {
            "description": "Customer-originated entry"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Remove an entry (the announcement is withdrawn). An entry tied to a customer community cannot be deleted",
        "tags": [
          "Upstream mitigation"
        ],
        "x-audited": true,
        "x-required-permission": "escalation:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getEscalationsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscalationView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Entry not found (another tenant's entry also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          }
        },
        "summary": "Single entry",
        "tags": [
          "Upstream mitigation"
        ],
        "x-required-permission": "escalation:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/escalations/{id}/approve": {
      "post": {
        "operationId": "postEscalationsByIdApprove",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EscalationDecision"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/EscalationView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Entry not found"
          },
          "409": {
            "description": "Entry is not a pending suggestion"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Approve a pending suggestion (source=policy, status=pending): it becomes active and its duration starts at approval time (default 1 h)",
        "tags": [
          "Upstream mitigation"
        ],
        "x-audited": true,
        "x-required-permission": "escalation:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/escalations/{id}/deny": {
      "post": {
        "operationId": "postEscalationsByIdDeny",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Entry not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Upstream entries need BGP to be enabled on this appliance"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Reject a pending suggestion (the entry is deleted)",
        "tags": [
          "Upstream mitigation"
        ],
        "x-audited": true,
        "x-required-permission": "escalation:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/events": {
      "get": {
        "operationId": "getEvents",
        "parameters": [
          {
            "description": "equivalent to the Last-Event-ID header",
            "in": "query",
            "name": "last_event_id",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "text/event-stream": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Event stream is not configured"
          },
          "503": {
            "description": "Too many subscribers (200 total, 5 per identity)"
          }
        },
        "summary": "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.",
        "tags": [
          "Live events"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/export": {
      "get": {
        "operationId": "getExport",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ExportView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Export is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "export:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/geo/asn-names": {
      "get": {
        "operationId": "getGeoAsnNames",
        "parameters": [
          {
            "in": "query",
            "name": "asn",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ASNNamesResponse"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid ASN / too many ASNs"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "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",
        "tags": [
          "GeoIP"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/geo/lookup": {
      "get": {
        "operationId": "getGeoLookup",
        "parameters": [
          {
            "in": "query",
            "name": "ip",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GeoLookupView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid IP"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "GeoIP is not configured"
          }
        },
        "summary": "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)",
        "tags": [
          "GeoIP"
        ],
        "x-required-permission": "geo:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/geo/status": {
      "get": {
        "operationId": "getGeoStatus",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GeoStatusView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "GeoIP is not configured"
          }
        },
        "summary": "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)",
        "tags": [
          "GeoIP"
        ],
        "x-required-permission": "geo:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/geo/update": {
      "get": {
        "operationId": "getGeoUpdate",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Automatic update is not configured"
          }
        },
        "summary": "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",
        "tags": [
          "GeoIP"
        ],
        "x-required-permission": "geo:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/health": {
      "get": {
        "operationId": "getHealth",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthResponse"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Health",
        "tags": [
          "System"
        ],
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/hosts": {
      "get": {
        "operationId": "getHosts",
        "parameters": [
          {
            "in": "query",
            "name": "n",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/HostInfo"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Top destinations by traffic (tenant: own prefixes only)",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents": {
      "get": {
        "operationId": "getIncidents",
        "parameters": [
          {
            "description": "active | ended | terminated | closed (ended+terminated)",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "enum": [
                "active",
                "ended",
                "terminated",
                "closed"
              ],
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "prefix_id",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "e.g. udp_flood, syn_flood",
            "in": "query",
            "name": "vector",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "start \u003e= from (RFC3339)",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "start \u003c= to (RFC3339)",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "page size (default 50, max 500)",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "`next` value from the previous response (opaque)",
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IncidentList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid parameter/cursor"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records are not configured"
          }
        },
        "summary": "Attacks (incidents): filter and paginate; sorted by start time descending (tenant: own prefixes only)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-required-permission": "incident:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents/{id}": {
      "get": {
        "operationId": "getIncidentsById",
        "parameters": [
          {
            "description": "\u003cprefix_id\u003e-\u003cstart_unix\u003e",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IncidentDetail"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (for a tenant, another tenant's incident also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records are not configured"
          }
        },
        "summary": "Attack details: duration, peak values, vectors, start/end summaries (top sources), notes (tenants do not see notes)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-required-permission": "incident:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents/{id}/flows": {
      "get": {
        "operationId": "getIncidentsByIdFlows",
        "parameters": [
          {
            "description": "\u003cprefix_id\u003e-\u003cstart_unix\u003e",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "source IP or CIDR (sources may be spoofed)",
            "in": "query",
            "name": "src",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "destination IP or CIDR",
            "in": "query",
            "name": "dst",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "source port",
            "in": "query",
            "name": "sport",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "destination port",
            "in": "query",
            "name": "dport",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "tcp | udp | icmp | icmpv6 | gre | esp | sctp or 0-255",
            "in": "query",
            "name": "proto",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "pass | drop | would_drop | challenge",
            "in": "query",
            "name": "verdict",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "drop reason (e.g. rate, rule, blocklist)",
            "in": "query",
            "name": "reason",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "maximum flows (default 50, max 1000)",
            "in": "query",
            "name": "n",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ArchiveFlows"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid filter/parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Attack or its archive not found (for a tenant, another tenant's attack also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records or the sample archive are disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "incident:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents/{id}/notes": {
      "post": {
        "operationId": "postIncidentsByIdNotes",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NoteRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IncidentNote"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Note limit"
          },
          "422": {
            "description": "Empty or too long note"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Add a note to an attack (management roles only; at most 50 notes, 1000 characters)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-audited": true,
        "x-required-permission": "incident:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/incidents/{id}/samples": {
      "get": {
        "operationId": "getIncidentsByIdSamples",
        "parameters": [
          {
            "description": "\u003cprefix_id\u003e-\u003cstart_unix\u003e",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "source IP or CIDR (sources may be spoofed)",
            "in": "query",
            "name": "src",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "destination IP or CIDR",
            "in": "query",
            "name": "dst",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "source port",
            "in": "query",
            "name": "sport",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "destination port",
            "in": "query",
            "name": "dport",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "tcp | udp | icmp | icmpv6 | gre | esp | sctp or 0-255",
            "in": "query",
            "name": "proto",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "pass | drop | would_drop | challenge",
            "in": "query",
            "name": "verdict",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "drop reason (e.g. rate, rule, blocklist)",
            "in": "query",
            "name": "reason",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "page size (default 100, max 1000)",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "`next_offset` from the previous response",
            "in": "query",
            "name": "offset",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ArchiveSamples"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid filter/parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Attack or its archive not found (for a tenant, another tenant's attack also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records or the sample archive are disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "incident:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents/{id}/series": {
      "get": {
        "operationId": "getIncidentsByIdSeries",
        "parameters": [
          {
            "description": "\u003cprefix_id\u003e-\u003cstart_unix\u003e",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Series"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Attack or series record not found (for a tenant, another tenant's incident also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records or series recording are not configured"
          }
        },
        "summary": "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",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-required-permission": "incident:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/incidents/{id}/suggestions": {
      "get": {
        "operationId": "getIncidentsByIdSuggestions",
        "parameters": [
          {
            "description": "\u003cprefix_id\u003e-\u003cstart_unix\u003e",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "maximum suggestions (default 5, max 20)",
            "in": "query",
            "name": "max",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "minimum raw sample count for a cluster (default 30)",
            "in": "query",
            "name": "min_samples",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "minimum fraction of attack weight (0-1], default 0.05",
            "in": "query",
            "name": "min_coverage",
            "required": false,
            "schema": {
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuggestionsView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid filter/parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Attack or its archive not found (for a tenant, another tenant's attack also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Attack records or the sample archive are disabled"
          }
        },
        "summary": "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)",
        "tags": [
          "Forensics"
        ],
        "x-required-permission": "incident:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/incidents/{id}/terminate": {
      "post": {
        "operationId": "postIncidentsByIdTerminate",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TerminateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IncidentDetail"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Incident has already ended or the mode could not be changed"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-audited": true,
        "x-required-permission": "incident:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/license": {
      "get": {
        "operationId": "getLicense",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenseStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "License management is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "System"
        ],
        "x-required-permission": "license:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/limiters": {
      "get": {
        "operationId": "getLimiters",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/LimiterInfo"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Rate limiters",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/lists": {
      "get": {
        "operationId": "getLists",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Lists"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Allow/deny lists",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/mitigations": {
      "get": {
        "operationId": "getMitigations",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/MitigationView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Approval mechanism is disabled"
          }
        },
        "summary": "Mitigation requests awaiting an operator decision (on auto prefixes whose profile has `detection.approval.required`). Staff only; tenants have no access",
        "tags": [
          "Mitigation approvals"
        ],
        "x-required-permission": "mitigation:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/mitigations/{id}/approve": {
      "post": {
        "operationId": "postMitigationsByIdApprove",
        "parameters": [
          {
            "description": "attack (incident) ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MitigationDecision"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "No pending approval (already decided, expired, or the attack has ended)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Approval mechanism is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Mitigation approvals"
        ],
        "x-audited": true,
        "x-required-permission": "mitigation:decide",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/mitigations/{id}/deny": {
      "post": {
        "operationId": "postMitigationsByIdDeny",
        "parameters": [
          {
            "description": "attack (incident) ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MitigationDecision"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "No pending approval (already decided, expired, or the attack has ended)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Approval mechanism is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Deny the mitigation: the prefix stays in SENSOR and approval is not requested again for this attack (the attack is NOT mitigated)",
        "tags": [
          "Mitigation approvals"
        ],
        "x-audited": true,
        "x-required-permission": "mitigation:decide",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/my/notifications": {
      "get": {
        "operationId": "getMyNotifications",
        "parameters": [
          {
            "description": "staff only: which customer (a customer sees its own; another customer's returns 404)",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyNotifications"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "The tenant parameter is required for staff"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Customer not found"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "The customer's notification channels (target masked: scheme+host only) and recent deliveries (error details are not provided)",
        "tags": [
          "Customer account"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/my/notifications/settings": {
      "get": {
        "operationId": "getMyNotificationsSettings",
        "parameters": [
          {
            "description": "staff only: which customer (a customer sees its own; another customer's returns 404)",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyNotifySettings"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "The tenant parameter is required for staff"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Customer not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "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",
        "tags": [
          "Customer account"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putMyNotificationsSettings",
        "parameters": [
          {
            "description": "staff only: which customer (a customer sees its own; another customer's returns 404)",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MyNotifyInput"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyNotifySettings"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Customer not found"
          },
          "409": {
            "description": "The provider has not offered e-mail notifications"
          },
          "422": {
            "description": "Invalid settings"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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)",
        "tags": [
          "Customer account"
        ],
        "x-audited": true,
        "x-required-permission": "mynotify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/my/notifications/test": {
      "post": {
        "operationId": "postMyNotificationsTest",
        "parameters": [
          {
            "description": "staff only: which customer (a customer sees its own; another customer's returns 404)",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyNotifyTestResult"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "No enabled settings saved yet"
          },
          "429": {
            "description": "Wait a minute between tests"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Customer account"
        ],
        "x-audited": true,
        "x-required-permission": "mynotify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/my/protection": {
      "get": {
        "operationId": "getMyProtection",
        "parameters": [
          {
            "description": "staff only: which customer (a customer sees its own; another customer's returns 404)",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MyProtection"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "The tenant parameter is required for staff"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Customer not found (another customer's also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "No protection configuration"
          }
        },
        "summary": "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",
        "tags": [
          "Customer account"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/notify/channels": {
      "get": {
        "operationId": "getNotifyChannels",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ChannelView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Notification channels (no secret fields; `secret_set`, delivery counters). ETag = configuration version",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postNotifyChannels",
        "parameters": [
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChannelInput"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a channel (webhook|syslog|email|telegram|snmp). Secret fields (secret) are write-only; they never appear in any response or audit record.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/notify/channels/{id}": {
      "delete": {
        "operationId": "deleteNotifyChannelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a channel (409 if rules use it). Secret fields (secret) are write-only; they never appear in any response or audit record.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getNotifyChannelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChannelView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Channel details",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putNotifyChannelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ChannelInput"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/notify/channels/{id}/test": {
      "post": {
        "operationId": "postNotifyChannelsByIdTest",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyTestResult"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Channel not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Tests the channel synchronously (sends a test notification); the result is also written to the history",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/notify/history": {
      "get": {
        "operationId": "getNotifyHistory",
        "parameters": [
          {
            "description": "channel ID",
            "in": "query",
            "name": "channel",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "default 100, max 1000",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/Delivery"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Delivery history (newest first): result ok|retry|dead|suppressed|dropped|cooldown|test_ok|test_failed, error (without secrets)",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/notify/meta": {
      "get": {
        "operationId": "getNotifyMeta",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyMeta"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Event types (severity, non-staff visibility), severity levels and channel types",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/notify/rules": {
      "get": {
        "operationId": "getNotifyRules",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/NotifyRule"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Notification rules",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postNotifyRules",
        "parameters": [
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NotifyRule"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/notify/rules/{id}": {
      "delete": {
        "operationId": "deleteNotifyRulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getNotifyRulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyRule"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          }
        },
        "summary": "Rule details",
        "tags": [
          "Integrations"
        ],
        "x-required-permission": "notify:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putNotifyRulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NotifyRule"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NotifyChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Already exists or in use (`used_by`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Notifications are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Replace a rule. Secret fields (secret) are write-only; they never appear in any response or audit record.",
        "tags": [
          "Integrations"
        ],
        "x-audited": true,
        "x-required-permission": "notify:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/overview": {
      "get": {
        "operationId": "getOverview",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Overview"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Overview: rates, totals, active/recent attacks, most attacked destinations, system health, feature flags (tenant: own prefixes only)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes": {
      "get": {
        "operationId": "getPrefixes",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/PrefixView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Protected prefixes (tenant: own only)",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes/{id}": {
      "patch": {
        "operationId": "patchPrefixesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrefixPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrefixChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/hosts": {
      "get": {
        "operationId": "getPrefixesByIdHosts",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "maximum records (default 20, max 1000)",
            "in": "query",
            "name": "n",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/HostRow"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found (for a tenant, another tenant's prefix also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Destination IPs within the prefix: exact counters + (if available) estimated rate/share from sampling (Traffic Analyzer)",
        "tags": [
          "Overview \u0026 attacks"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes/{id}/learning": {
      "get": {
        "operationId": "getPrefixesByIdLearning",
        "parameters": [
          {
            "description": "prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LearningView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found (for a tenant, another tenant's prefix also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Learning data is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Baseline learning"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes/{id}/learning/reset": {
      "post": {
        "operationId": "postPrefixesByIdLearningReset",
        "parameters": [
          {
            "description": "prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found (for a tenant, another tenant's prefix also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Learning data is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete the learned distribution (new learning period). Permission: mode change (management roles; a tenant only for its own prefix and if allowed)",
        "tags": [
          "Baseline learning"
        ],
        "x-audited": true,
        "x-required-permission": "mode:set",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/lists": {
      "get": {
        "operationId": "getPrefixesByIdLists",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrefixListView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found or not visible"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Allow \u0026 deny lists"
        ],
        "x-required-permission": "prefixlist:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes/{id}/lists/{kind}": {
      "delete": {
        "operationId": "deletePrefixesByIdListsByKind",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "allow | deny",
            "in": "path",
            "name": "kind",
            "required": true,
            "schema": {
              "enum": [
                "allow",
                "deny"
              ],
              "type": "string"
            }
          },
          {
            "description": "entry to delete",
            "in": "query",
            "name": "cidr",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "cidr is missing"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix or entry not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete an entry from the list (with `?cidr=`)",
        "tags": [
          "Allow \u0026 deny lists"
        ],
        "x-audited": true,
        "x-required-permission": "prefixlist:write",
        "x-roles": [
          "operator"
        ]
      },
      "post": {
        "operationId": "postPrefixesByIdListsByKind",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "allow | deny",
            "in": "path",
            "name": "kind",
            "required": true,
            "schema": {
              "enum": [
                "allow",
                "deny"
              ],
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PrefixListAdd"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PrefixListEntry"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found or not visible"
          },
          "409": {
            "description": "Duplicate entry, or the same network is in the opposite list"
          },
          "422": {
            "description": "Invalid CIDR/quota exceeded"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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 \u003e global deny \u003e **prefix allow** \u003e prefix deny \u003e …; 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",
        "tags": [
          "Allow \u0026 deny lists"
        ],
        "x-audited": true,
        "x-required-permission": "prefixlist:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/mode": {
      "put": {
        "operationId": "putPrefixesByIdMode",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ModeRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModeResponse"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Change the prefix mode (temporary). Tenant: own prefix only, if the tenant policy allows it, sensor/enforce only",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-audited": true,
        "x-required-permission": "mode:set",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/rules": {
      "get": {
        "operationId": "getPrefixesByIdRules",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomRulesView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found or not visible"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Custom rules"
        ],
        "x-required-permission": "prefixlist:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postPrefixesByIdRules",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomRuleRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomRuleView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix or rule not found / not visible"
          },
          "422": {
            "description": "Invalid rule or quota exceeded"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Add a custom rule. Order: global allow/deny \u003e customer allow/deny lists \u003e malformed packets \u003e **custom rules** (by priority, first match wins) \u003e 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)",
        "tags": [
          "Custom rules"
        ],
        "x-audited": true,
        "x-required-permission": "prefixlist:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/rules/{rid}": {
      "delete": {
        "operationId": "deletePrefixesByIdRulesByRid",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "custom rule ID",
            "in": "path",
            "name": "rid",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "format": "int32",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix or rule not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a custom rule",
        "tags": [
          "Custom rules"
        ],
        "x-audited": true,
        "x-required-permission": "prefixlist:write",
        "x-roles": [
          "operator"
        ]
      },
      "put": {
        "operationId": "putPrefixesByIdRulesByRid",
        "parameters": [
          {
            "description": "protected prefix ID",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "custom rule ID",
            "in": "path",
            "name": "rid",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CustomRuleRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomRuleView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix or rule not found / not visible"
          },
          "422": {
            "description": "Invalid rule or quota exceeded"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Custom rules"
        ],
        "x-audited": true,
        "x-required-permission": "prefixlist:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/prefixes/{id}/series": {
      "get": {
        "operationId": "getPrefixesByIdSeries",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "1s (global and prefixes under attack only) | 10s (default) | 1m, 1h (disk series; missing point = 0)",
            "in": "query",
            "name": "res",
            "required": false,
            "schema": {
              "enum": [
                "1s",
                "10s",
                "1m",
                "1h"
              ],
              "type": "string"
            }
          },
          {
            "description": "RFC3339; default: 15 min ago for 1s, 1 h for 10s, 6 h for 1m, 7 days for 1h",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "RFC3339; default: now. Maximum range: 1s/10s 24 hours, 1m 7 days, 1h 400 days",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SeriesResponse"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found (for a tenant, another tenant's prefix also returns 404)"
          },
          "409": {
            "description": "1 s resolution is not kept for this prefix (not under attack)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry or (for 1m/1h) disk series is not configured"
          }
        },
        "summary": "Prefix time series (pps/bps: rx, clean, dropped, would-drop)",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/prefixes/{id}/top": {
      "get": {
        "operationId": "getPrefixesByIdTop",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopResponse"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Prefix not found (for a tenant, another tenant's prefix also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry is not configured"
          }
        },
        "summary": "Sample-based summary: top sources, /24-/48, destinations, ports, protocols, distinct source estimate (ESTIMATED)",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "prefix:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection": {
      "get": {
        "operationId": "getProtection",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtectionSummary"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Protection configuration summary: version/ETag, static and managed record counts, compile warnings. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection/groups": {
      "get": {
        "operationId": "getProtectionGroups",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/GroupView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "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.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postProtectionGroups",
        "parameters": [
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Group"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a group (id is assigned if not given). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/groups/{id}": {
      "delete": {
        "operationId": "deleteProtectionGroupsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a group (prefixes keep using the group ID; only the name is lost). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getProtectionGroupsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Group details. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putProtectionGroupsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Group"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Replace a group. If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/limiters": {
      "get": {
        "operationId": "getProtectionLimiters",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/LimiterView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Limiters (static + managed) and the profiles using them. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postProtectionLimiters",
        "parameters": [
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Limiter"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LimiterChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a managed limiter. If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/limiters/{name}": {
      "delete": {
        "operationId": "deleteProtectionLimitersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a managed limiter (409 if rules use it). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getProtectionLimitersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LimiterView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Limiter details. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putProtectionLimitersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Limiter"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LimiterChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Replace a managed limiter (the name cannot be changed). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/lists": {
      "get": {
        "operationId": "getProtectionLists",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ListsView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Allow/deny lists (static + managed; managed entries include note, author, time). The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection/lists/{kind}": {
      "delete": {
        "operationId": "deleteProtectionListsByKind",
        "parameters": [
          {
            "in": "path",
            "name": "kind",
            "required": true,
            "schema": {
              "enum": [
                "allow",
                "deny"
              ],
              "type": "string"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "entry to delete",
            "in": "query",
            "name": "cidr",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Remove a managed entry from the list (409 for static). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      },
      "post": {
        "operationId": "postProtectionListsByKind",
        "parameters": [
          {
            "in": "path",
            "name": "kind",
            "required": true,
            "schema": {
              "enum": [
                "allow",
                "deny"
              ],
              "type": "string"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ListEntryRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Add an entry to an allow/deny list. The lists are GLOBAL: they affect all prefixes. If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/payload-templates": {
      "get": {
        "operationId": "getProtectionPayloadTemplates",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayloadTemplateList"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "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",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection/profiles": {
      "get": {
        "operationId": "getProtectionProfiles",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ProfileView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Protection profiles (static + managed): with the prefixes using them and rule hit counters. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postProtectionProfiles",
        "parameters": [
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Profile"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a managed profile (ID 128-255 is assigned by the server). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/profiles/{id}": {
      "delete": {
        "operationId": "deleteProtectionProfilesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a managed profile (409 if prefixes use it). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getProtectionProfilesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Profile details. The response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putProtectionProfilesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Profile"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Fully replace a managed profile (409 for a static profile). If-Match (ETag \"p\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/revisions": {
      "get": {
        "operationId": "getProtectionRevisions",
        "parameters": [
          {
            "description": "default 50, max 100",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "`next` from the previous response",
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RevisionList"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Protection version history (newest first; the last 100 versions are kept)",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection/revisions/{n}": {
      "get": {
        "operationId": "getProtectionRevisionsByN",
        "parameters": [
          {
            "in": "path",
            "name": "n",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RevisionDetail"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Version not found or outside retention"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          }
        },
        "summary": "Version snapshot and diff against the parent version (0: initial)",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protection/revisions/{n}/rollback": {
      "post": {
        "operationId": "postProtectionRevisionsByNRollback",
        "parameters": [
          {
            "in": "path",
            "name": "n",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "true: validate and preview (diff, impact, warnings); nothing is written, no audit record is produced",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "409": {
            "description": "Static record (cannot be changed), already exists or in use (`used_by`)"
          },
          "412": {
            "description": "If-Match does not match the current version (`current_etag`)"
          },
          "422": {
            "description": "Invalid configuration (`problems`: line-by-line reasons)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Managed state store is disabled"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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\u003cn\u003e\") is an optional precondition; the response ETag header is the current protection version.",
        "tags": [
          "Protection"
        ],
        "x-audited": true,
        "x-required-permission": "protection:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/protection/templates": {
      "get": {
        "operationId": "getProtectionTemplates",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateList"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Built-in starter profiles (sample values; must be tuned to your traffic)",
        "tags": [
          "Protection"
        ],
        "x-required-permission": "protection:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protos": {
      "get": {
        "operationId": "getProtos",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ProtoView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Protocol counters",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/protos/series": {
      "get": {
        "operationId": "getProtosSeries",
        "parameters": [
          {
            "description": "10s | 1m",
            "in": "query",
            "name": "res",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "RFC3339",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "RFC3339",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProtoSeriesResponse"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid resolution or range"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/report-schedules": {
      "get": {
        "operationId": "getReportSchedules",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ScheduleInfo"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          }
        },
        "summary": "Report schedule definitions (with last/next run). ETag = definition version",
        "tags": [
          "Reports"
        ],
        "x-required-permission": "report:config",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postReportSchedules",
        "parameters": [
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Definition"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "Already exists"
          },
          "422": {
            "description": "Invalid definition (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/report-schedules/{id}": {
      "delete": {
        "operationId": "deleteReportSchedulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleChange"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a definition (generated reports are kept)",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getReportSchedulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleInfo"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          }
        },
        "summary": "Schedule definition",
        "tags": [
          "Reports"
        ],
        "x-required-permission": "report:config",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putReportSchedulesById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "true: validate only (nothing is written, no audit record is produced)",
            "in": "query",
            "name": "dry_run",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Definition"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ScheduleChange"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "422": {
            "description": "Invalid definition (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Replace a definition",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/report-schedules/{id}/run": {
      "post": {
        "operationId": "postReportSchedulesByIdRun",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportMeta"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Run a definition now (for the last completed period; also sent to delivery channels)",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/reports": {
      "get": {
        "operationId": "getReports",
        "parameters": [
          {
            "in": "query",
            "name": "type",
            "required": false,
            "schema": {
              "enum": [
                "monthly_summary",
                "tenant_sla",
                "incident"
              ],
              "type": "string"
            }
          },
          {
            "description": "staff only",
            "in": "query",
            "name": "tenant",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "e.g. 2026-09",
            "in": "query",
            "name": "period",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "default 100, max 500",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ReportMeta"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          }
        },
        "summary": "Generated reports (newest first). The tenant role sees ONLY its own reports (definition/generator/trigger fields are removed)",
        "tags": [
          "Reports"
        ],
        "x-required-permission": "report:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/reports/generate": {
      "post": {
        "operationId": "postReportsGenerate",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ReportGenerateRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportMeta"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Incident not found"
          },
          "422": {
            "description": "Invalid request (`problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/reports/{id}": {
      "delete": {
        "operationId": "deleteReportsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "type": "boolean"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a report",
        "tags": [
          "Reports"
        ],
        "x-audited": true,
        "x-required-permission": "report:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getReportsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ReportMeta"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Reports are not configured"
          }
        },
        "summary": "Report metadata (another tenant's report returns 404)",
        "tags": [
          "Reports"
        ],
        "x-required-permission": "report:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/reports/{id}/pdf": {
      "get": {
        "operationId": "getReportsByIdPdf",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "500": {
            "description": "File is corrupted (digest mismatch)"
          },
          "501": {
            "description": "Reports are not configured"
          }
        },
        "summary": "The report's PDF file (`Content-Disposition: attachment`, digest is verified)",
        "tags": [
          "Reports"
        ],
        "x-required-permission": "report:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/rules": {
      "get": {
        "operationId": "getRules",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/RuleInfo"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Profile rules and hit counters",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/selfprot": {
      "get": {
        "operationId": "getSelfprot",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SelfProtStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Self-protection is not available (no data plane)"
          }
        },
        "summary": "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)",
        "tags": [
          "Appliance self-protection"
        ],
        "x-required-permission": "selfprot:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/selfprot/seen": {
      "get": {
        "operationId": "getSelfprotSeen",
        "parameters": [
          {
            "description": "maximum entries (1-1000), default 100",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/SelfProtSeenView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid limit"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Self-protection is not available (no data plane)"
          }
        },
        "summary": "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)",
        "tags": [
          "Appliance self-protection"
        ],
        "x-required-permission": "selfprot:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/series": {
      "get": {
        "operationId": "getSeries",
        "parameters": [
          {
            "description": "1s (global and prefixes under attack only) | 10s (default) | 1m, 1h (disk series; missing point = 0)",
            "in": "query",
            "name": "res",
            "required": false,
            "schema": {
              "enum": [
                "1s",
                "10s",
                "1m",
                "1h"
              ],
              "type": "string"
            }
          },
          {
            "description": "RFC3339; default: 15 min ago for 1s, 1 h for 10s, 6 h for 1m, 7 days for 1h",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "description": "RFC3339; default: now. Maximum range: 1s/10s 24 hours, 1m 7 days, 1h 400 days",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SeriesResponse"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid parameter"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry or (for 1m/1h) disk series is not configured"
          }
        },
        "summary": "Global time series",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/synauth": {
      "get": {
        "operationId": "getSynauth",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SynAuthInfo"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "SYN authentication status",
        "tags": [
          "Prefixes \u0026 attacks"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/bgp": {
      "get": {
        "operationId": "getSystemBgp",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BGPSettings"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not available on this installation"
          }
        },
        "summary": "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)",
        "tags": [
          "BGP"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/certificate": {
      "get": {
        "operationId": "getSystemCertificate",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CertmgrStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Certificate management is disabled"
          }
        },
        "summary": "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",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/health": {
      "get": {
        "operationId": "getSystemHealth",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemHealthResponse"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "System information is not configured"
          }
        },
        "summary": "System health: host (CPU cores, memory, disk, temperature), the service, telemetry, audit chain, TLS",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/history": {
      "get": {
        "operationId": "getSystemHistory",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SystemHistory"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "System information is not configured"
          }
        },
        "summary": "CPU/memory/temperature history for the last hour (10 s interval, kept in the service memory; reset on restart)",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/interfaces": {
      "get": {
        "operationId": "getSystemInterfaces",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/NetworkInterface"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "System information is not configured"
          }
        },
        "summary": "Network interfaces: link state/speed, driver, queue count, error and drop counters, XDP mode",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/links": {
      "get": {
        "operationId": "getSystemLinks",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/LinkRow"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not available on this installation"
          }
        },
        "summary": "Data ports with their configured and current speed / FEC (the management port is not listed)",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/portal": {
      "get": {
        "operationId": "getSystemPortal",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PortalView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not available on this installation"
          }
        },
        "summary": "Connection of the separate portal server: listener ports, allowed portal server addresses and client certificate fingerprints, and this appliance's certificate fingerprint for pinning",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/routed": {
      "get": {
        "operationId": "getSystemRouted",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RoutedView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Mode is not available"
          }
        },
        "summary": "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)",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/routed/bfd": {
      "get": {
        "operationId": "getSystemRoutedBfd",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BFDView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not available on this installation"
          }
        },
        "summary": "BFD and maintenance status of routed inline mode: sessions with the upstream router and the downstream switch, health gate and maintenance mode",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/session": {
      "get": {
        "operationId": "getSystemSession",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionSettings"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Not available on this installation"
          }
        },
        "summary": "Web session timeouts (idle and maximum length) for all web users",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/tls": {
      "get": {
        "operationId": "getSystemTls",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TlsutilCertInfo"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "No TLS listener"
          }
        },
        "summary": "TLS certificate summary (fingerprint, validity)",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/updates": {
      "get": {
        "operationId": "getSystemUpdates",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UpdateView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Update repository is not configured"
          }
        },
        "summary": "Application releases: active/previous version, activation awaiting confirmation, installed versions, recent events, rolled-back versions. READ-ONLY: install/activate/rollback from the console",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/system/updates/job": {
      "get": {
        "operationId": "getSystemUpdatesJob",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Job"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Panel updates are not configured"
          },
          "503": {
            "description": "Helper service is not responding"
          }
        },
        "summary": "Status of the last panel update: running | succeeded | failed, package digest (SHA-256), tail of the installer output, whether a reboot is required",
        "tags": [
          "System"
        ],
        "x-required-permission": "system:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/telemetry/status": {
      "get": {
        "operationId": "getTelemetryStatus",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TelemetryStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry is not configured"
          }
        },
        "summary": "Telemetry status: sampling rate, processed/rejected samples, kernel ring drops",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/tenants": {
      "get": {
        "operationId": "getTenants",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/TenantView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Tenants (the tenant role sees only itself): quota status, prefixes, active attacks",
        "tags": [
          "Customers \u0026 usage"
        ],
        "x-required-permission": "tenant:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/tenants/{id}": {
      "get": {
        "operationId": "getTenantsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TenantView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Single tenant",
        "tags": [
          "Customers \u0026 usage"
        ],
        "x-required-permission": "tenant:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/tenants/{id}/usage": {
      "get": {
        "operationId": "getTenantsByIdUsage",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "step",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/UsageSample"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Tenant usage samples (5 min); aggregated by step",
        "tags": [
          "Customers \u0026 usage"
        ],
        "x-required-permission": "usage:read",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/ti/entries": {
      "delete": {
        "operationId": "deleteTiEntries",
        "parameters": [
          {
            "in": "query",
            "name": "cidr",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "default own",
            "in": "query",
            "name": "category",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "cidr is missing"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Entry not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a local entry",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getTiEntries",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/OwnEntry"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          }
        },
        "summary": "Local entries (your own observations); expired ones are not listed",
        "tags": [
          "Threat intelligence"
        ],
        "x-required-permission": "ti:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postTiEntries",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TIEntryRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OwnEntry"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "Entry exists / limit reached"
          },
          "422": {
            "description": "Invalid CIDR/category/TTL"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/ti/feeds": {
      "get": {
        "operationId": "getTiFeeds",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/URLFeedView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          }
        },
        "summary": "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",
        "tags": [
          "Threat intelligence"
        ],
        "x-required-permission": "ti:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postTiFeeds",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/TIFeedRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/URLFeedView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "A feed with the same name exists / feed limit reached"
          },
          "422": {
            "description": "Invalid name/URL/category/interval"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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 \u003c /8 and IPv6 \u003c /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`",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/ti/feeds/{id}": {
      "delete": {
        "operationId": "deleteTiFeedsById",
        "parameters": [
          {
            "description": "URL feed ID (uf-…)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Feed not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a URL feed: its entries are removed from the kernel and its data is deleted",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      },
      "put": {
        "operationId": "putTiFeedsById",
        "parameters": [
          {
            "description": "URL feed ID (uf-…)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/URLFeedPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/URLFeedView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Feed not found"
          },
          "409": {
            "description": "A feed with the same name exists / enabling would exceed the total limit"
          },
          "422": {
            "description": "Invalid name/URL/category/interval"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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)",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/ti/feeds/{id}/refresh": {
      "post": {
        "operationId": "postTiFeedsByIdRefresh",
        "parameters": [
          {
            "description": "URL feed ID (uf-…)",
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/URLFeedView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Feed not found"
          },
          "409": {
            "description": "This feed is already downloading / total entry limit"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          },
          "502": {
            "description": "Download or parsing failed (previous data kept)"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "Threat intelligence"
        ],
        "x-audited": true,
        "x-required-permission": "ti:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/ti/lookup": {
      "get": {
        "operationId": "getTiLookup",
        "parameters": [
          {
            "in": "query",
            "name": "ip",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TILookupView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid IP"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          }
        },
        "summary": "Which categories/entries an IP matches (feed and local; most specific to most general)",
        "tags": [
          "Threat intelligence"
        ],
        "x-required-permission": "ti:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/ti/status": {
      "get": {
        "operationId": "getTiStatus",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TIStatusView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Threat intelligence is not configured"
          }
        },
        "summary": "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",
        "tags": [
          "Threat intelligence"
        ],
        "x-required-permission": "ti:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/top": {
      "get": {
        "operationId": "getTop",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TopResponse"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry is not configured"
          }
        },
        "summary": "Global sample-based summary (including per-prefix breakdown)",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/top/series": {
      "get": {
        "operationId": "getTopSeries",
        "parameters": [
          {
            "in": "query",
            "name": "dim",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "metric",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "res",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "n",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DimSeriesResponse"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid dimension/metric/resolution/range"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Telemetry is disabled"
          }
        },
        "summary": "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)",
        "tags": [
          "Traffic"
        ],
        "x-required-permission": "global:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/tunnel-status": {
      "get": {
        "operationId": "getTunnelStatus",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TunnelSystem"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          }
        },
        "summary": "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",
        "tags": [
          "GRE tunnels"
        ],
        "x-required-permission": "tunnel:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    },
    "/v1/tunnels": {
      "get": {
        "operationId": "getTunnels",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/TunnelView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          }
        },
        "summary": "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",
        "tags": [
          "GRE tunnels"
        ],
        "x-required-permission": "tunnel:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "post": {
        "operationId": "postTunnels",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Tunnel"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TunnelView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tenant not found"
          },
          "409": {
            "description": "Conflict"
          },
          "422": {
            "description": "Validation error (reasons in `problems`)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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\u003cid\u003e` GRE interface is created in the kernel, the inner address is assigned and MSS clamping is added. The ID is assigned automatically",
        "tags": [
          "GRE tunnels"
        ],
        "x-audited": true,
        "x-required-permission": "tunnel:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/tunnels/{id}": {
      "delete": {
        "operationId": "deleteTunnelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {},
                  "type": "object"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tunnel not found"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a tunnel (the kernel interface is removed)",
        "tags": [
          "GRE tunnels"
        ],
        "x-audited": true,
        "x-required-permission": "tunnel:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getTunnelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TunnelView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tunnel not found (another tenant's tunnel also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          }
        },
        "summary": "Single tunnel",
        "tags": [
          "GRE tunnels"
        ],
        "x-required-permission": "tunnel:read",
        "x-roles": [
          "operator",
          "viewer"
        ]
      },
      "put": {
        "operationId": "putTunnelsById",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Tunnel"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TunnelView"
                }
              }
            },
            "description": "Success"
          },
          "400": {
            "description": "Invalid request"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Tunnel not found"
          },
          "409": {
            "description": "Tenant cannot be changed"
          },
          "422": {
            "description": "Validation error"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Tunnels are not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "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",
        "tags": [
          "GRE tunnels"
        ],
        "x-audited": true,
        "x-required-permission": "tunnel:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/usage": {
      "get": {
        "operationId": "getUsage",
        "parameters": [
          {
            "in": "query",
            "name": "month",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "enum": [
                "json",
                "csv"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsageReport"
                }
              },
              "text/csv": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Monthly usage/billing report (TB, 95th percentile, attacks); the tenant role sees only itself",
        "tags": [
          "Customers \u0026 usage"
        ],
        "x-required-permission": "usage:read",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users": {
      "get": {
        "operationId": "getUsers",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/UserView"
                  },
                  "type": "array"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Users (an operator sees only users with tenant roles)",
        "tags": [
          "Users"
        ],
        "x-required-permission": "user:read",
        "x-roles": [
          "operator"
        ]
      },
      "post": {
        "operationId": "postUsers",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "409": {
            "description": "Conflict"
          },
          "422": {
            "description": "Validation rejected"
          },
          "429": {
            "description": "Rate limited"
          },
          "501": {
            "description": "Feature is not configured"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Create a user (admin; an operator can create web tenant users only)",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users/{name}": {
      "delete": {
        "operationId": "deleteUsersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "409": {
            "description": "Static record or yourself"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Delete a user (credentials and tokens are also deleted)",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      },
      "get": {
        "operationId": "getUsersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserView"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Single user",
        "tags": [
          "Users"
        ],
        "x-required-permission": "user:read",
        "x-roles": [
          "operator"
        ]
      },
      "patch": {
        "operationId": "patchUsersByName",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserPatch"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "409": {
            "description": "Static record or your own role"
          },
          "422": {
            "description": "Validation rejected"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Update a user (role/tenant/web/unix_user; managed records)",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users/{name}/password": {
      "post": {
        "operationId": "postUsersByNamePassword",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SetPasswordRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "422": {
            "description": "Weak password"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Set/reset a password (sessions and tokens are terminated; by default it must be changed at first login)",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users/{name}/sessions": {
      "delete": {
        "operationId": "deleteUsersByNameSessions",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Terminate all of the user's sessions",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users/{name}/totp": {
      "delete": {
        "operationId": "deleteUsersByNameTotp",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Reset 2FA",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/users/{name}/unlock": {
      "post": {
        "operationId": "postUsersByNameUnlock",
        "parameters": [
          {
            "in": "path",
            "name": "name",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NameStatus"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "404": {
            "description": "Not found (a user you cannot manage also returns 404)"
          },
          "429": {
            "description": "Rate limited"
          },
          "503": {
            "description": "Audit record could not be written (operation not performed)"
          }
        },
        "summary": "Unlock a locked account",
        "tags": [
          "Users"
        ],
        "x-audited": true,
        "x-required-permission": "user:write",
        "x-roles": [
          "operator"
        ]
      }
    },
    "/v1/whoami": {
      "get": {
        "operationId": "getWhoami",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Identity"
                }
              }
            },
            "description": "Success"
          },
          "401": {
            "description": "Authentication required"
          },
          "403": {
            "description": "Forbidden: missing permission, another customer's resource, or a read-only token used for a change"
          },
          "429": {
            "description": "Rate limited"
          }
        },
        "summary": "Caller identity",
        "tags": [
          "Authentication"
        ],
        "x-roles": [
          "operator",
          "viewer"
        ]
      }
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "servers": [
    {
      "url": "https://mssp.example.com:8443"
    }
  ],
  "tags": [
    {
      "description": "API tokens of the signed-in user. Tokens are created and revoked in the panel (user menu → API tokens).",
      "name": "Authentication"
    },
    {
      "description": "Dashboard summary and attack (incident) records.",
      "name": "Overview \u0026 attacks"
    },
    {
      "description": "Protected prefixes, their protection mode, live attack state and counters.",
      "name": "Prefixes \u0026 attacks"
    },
    {
      "description": "Sampled traffic: time series, top talkers and host statistics.",
      "name": "Traffic"
    },
    {
      "description": "Packet samples and flows recorded during attacks; packet captures (PCAP).",
      "name": "Forensics"
    },
    {
      "description": "Server-Sent Events stream for attack and state changes.",
      "name": "Live events"
    },
    {
      "description": "The customer's protection summary and its own e-mail notification settings.",
      "name": "Customer account"
    },
    {
      "description": "Learned normal-traffic baselines used for detection.",
      "name": "Baseline learning"
    },
    {
      "description": "Per-prefix source allow/deny lists.",
      "name": "Allow \u0026 deny lists"
    },
    {
      "description": "Per-prefix custom filtering rules.",
      "name": "Custom rules"
    },
    {
      "description": "Protection groups, profiles, rules and rate limiters.",
      "name": "Protection"
    },
    {
      "description": "Mitigations waiting for operator approval.",
      "name": "Mitigation approvals"
    },
    {
      "description": "RTBH / FlowSpec announcements to upstream routers.",
      "name": "Upstream mitigation"
    },
    {
      "description": "GRE tunnels used to return clean traffic.",
      "name": "GRE tunnels"
    },
    {
      "description": "BGP sessions and announced prefixes.",
      "name": "BGP"
    },
    {
      "description": "Attack and periodic reports (PDF).",
      "name": "Reports"
    },
    {
      "description": "Notification channels (e-mail, webhook, Telegram, syslog, SNMP), rules and delivery history.",
      "name": "Integrations"
    },
    {
      "description": "Customers and traffic usage for billing.",
      "name": "Customers \u0026 usage"
    },
    {
      "description": "Portal users of customers.",
      "name": "Users"
    },
    {
      "description": "Threat intelligence entries and feeds.",
      "name": "Threat intelligence"
    },
    {
      "description": "Country / ASN lookup.",
      "name": "GeoIP"
    },
    {
      "description": "Protection of the appliance's own addresses.",
      "name": "Appliance self-protection"
    },
    {
      "description": "Appliance health, interfaces, license and metrics.",
      "name": "System"
    }
  ]
}
