Version 2.4.7.20261116085428 · latest

XDP fast blocking xdp

Supported nodes run in fast mode and drop packets from banned and blacklisted IPs at the NIC; others run in standard mode with protection unchanged. Paid feature xdp.

Pick an endpoint to see its example call on the right.

Authentication: Admin only7 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/xdp/nodesList node XDP states

Authentication: Admin only

Query parameters

FieldTypeDescription
sincestring Start of "blocked today" (the panel sends the browser's local midnight); defaults to the master's UTC midnight. At most 7 days back.
filterstring Filter: all; fast mode; standard mode; auto = switched automatically in the last 7 days; offline. Defaults to all.
Values ["all","fast","standard","auto","offline"]Default "all"
POST/api/v2/xdp/nodes/enable-allEnable all nodes waiting for a manual enable

Authentication: Admin only

POST/api/v2/xdp/nodes/{id}/disableSwitch a node to standard mode

Authentication: Admin only

POST/api/v2/xdp/nodes/{id}/enableEnable fast mode on a node

Authentication: Admin only

POST/api/v2/xdp/pausePause XDP fast blocking network-wide

Authentication: Admin only

Request body application/json

FieldTypeDescription
durationRequiredstring 1h or 4h resume automatically; manual waits for a manual resume.
Values ["1h","4h","manual"]
POST/api/v2/xdp/resumeResume XDP fast blocking network-wide

Authentication: Admin only

GET/api/v2/xdp/statusXDP fast blocking overview

Authentication: Admin only

Query parameters

FieldTypeDescription
sincestring Start of "blocked today" (the panel sends the browser's local midnight); defaults to the master's UTC midnight. At most 7 days back.

XDP fast blocking object

FieldTypeDescription
auto_atstring Last automatic switch.
auto_reasonstring Reason code of the last automatic switch.
auto_resume_atstring Automatic resume time; absent means manual.
bansinteger Ban entries.
blocked_todayXdpBlocked Blocked traffic (packets dropped at the NIC). Omitted while the statistics store is unavailable; controls keep working.
can_disableboolean Can be switched to standard mode now.
can_enableboolean Fast mode can be enabled now.
capsstring[] Capabilities of the node agent (flood1: understands flood protection settings; syncookie: SYN cookies usable). Without flood1 the agent is too old and flood protection does not apply. Old agents omit it.
causestring Why standard: license, outdated node agent, switched manually, added during the license buffer, switched automatically, unsupported, another XDP program on a NIC, or never deployed and waiting for a manual enable (the first mount drops the NIC link).
Values ["license","agent_old","manual","not_kept","auto","unsupported","conflict","not_enabled"]
countsXdpCounts Node counts by mode.
detailstring Details reported by the node (such as the NIC).
durationRequiredstring 1h or 4h resume automatically; manual waits for a manual resume.
Values ["1h","4h","manual"]
enabledinteger Number of nodes enabled.
floodXdpFlood Flood protection state of the three items reported by the node.
idinteger Node id.
ipstring Node IP.
itemsXdpNode[] Nodes.
kernelstring Kernel version.
licenseXdpLicense License view of paid feature xdp.
max_entriesinteger Table capacity.
namestring Node name.
nicsXdpNic[] NICs.
off_sourcestring Source of the manual switch: admin or node-local.
Values ["admin","node_local"]
onlineboolean Online.
opstring Switch in progress on this node.
Values ["enable","disable"]
op_errorstring Reason code of the last failed enable (timeout when it timed out).
op_error_atstring When the last enable failed.
pausedboolean Paused network-wide.
paused_atstring Paused at.
progressXdpProgress Network-wide pause or resume in progress.
reasonstring Reason code reported by the node (kernel, driver, check_tcp443, ack_timeout, …); the panel maps it to text.
reported_atstring Last report.
statestring Displayed state: offline, fast, deploying, switching, paused, or standard.
Values ["offline","fast","deploying","switching","paused","standard"]
statusstring Header status: unlicensed, stopped, revoking, frozen (license expired), unsynced, paused, deploying, no_nodes, or normal.
Values ["unlicensed","stopped","revoking","frozen","unsynced","paused","deploying","no_nodes","normal"]
top_bansXdpTopBans Node with the most ban entries (out of its table capacity).

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command