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
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.
/api/v2/xdp/nodesList node XDP states
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
since | string | Start of "blocked today" (the panel sends the browser's local midnight); defaults to the master's UTC midnight. At most 7 days back. |
filter | string | Filter: all; fast mode; standard mode; auto = switched automatically in the last 7 days; offline. Defaults to all. |
/api/v2/xdp/nodes/enable-allEnable all nodes waiting for a manual enable
Authentication: Admin only
/api/v2/xdp/nodes/{id}/disableSwitch a node to standard mode
Authentication: Admin only
/api/v2/xdp/nodes/{id}/enableEnable fast mode on a node
Authentication: Admin only
/api/v2/xdp/pausePause XDP fast blocking network-wide
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
durationRequired | string | 1h or 4h resume automatically; manual waits for a manual resume. |
/api/v2/xdp/resumeResume XDP fast blocking network-wide
Authentication: Admin only
/api/v2/xdp/statusXDP fast blocking overview
Authentication: Admin only
Query parameters
| Field | Type | Description |
|---|---|---|
since | string | 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
| Field | Type | Description |
|---|---|---|
auto_at | string | Last automatic switch. |
auto_reason | string | Reason code of the last automatic switch. |
auto_resume_at | string | Automatic resume time; absent means manual. |
bans | integer | Ban entries. |
blocked_today | XdpBlocked | Blocked traffic (packets dropped at the NIC). Omitted while the statistics store is unavailable; controls keep working. |
can_disable | boolean | Can be switched to standard mode now. |
can_enable | boolean | Fast mode can be enabled now. |
caps | string[] | 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. |
cause | string | 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). |
counts | XdpCounts | Node counts by mode. |
detail | string | Details reported by the node (such as the NIC). |
durationRequired | string | 1h or 4h resume automatically; manual waits for a manual resume. |
enabled | integer | Number of nodes enabled. |
flood | XdpFlood | Flood protection state of the three items reported by the node. |
id | integer | Node id. |
ip | string | Node IP. |
items | XdpNode[] | Nodes. |
kernel | string | Kernel version. |
license | XdpLicense | License view of paid feature xdp. |
max_entries | integer | Table capacity. |
name | string | Node name. |
nics | XdpNic[] | NICs. |
off_source | string | Source of the manual switch: admin or node-local. |
online | boolean | Online. |
op | string | Switch in progress on this node. |
op_error | string | Reason code of the last failed enable (timeout when it timed out). |
op_error_at | string | When the last enable failed. |
paused | boolean | Paused network-wide. |
paused_at | string | Paused at. |
progress | XdpProgress | Network-wide pause or resume in progress. |
reason | string | Reason code reported by the node (kernel, driver, check_tcp443, ack_timeout, …); the panel maps it to text. |
reported_at | string | Last report. |
state | string | Displayed state: offline, fast, deploying, switching, paused, or standard. |
status | string | Header status: unlicensed, stopped, revoking, frozen (license expired), unsynced, paused, deploying, no_nodes, or normal. |
top_bans | XdpTopBans | 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.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"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"
}