Get DDoS filtering measurements
GET /api/v2/vps/{id}/ddos-scrubbing/traffic
Get what the DDoS filter measured for the VPS’s primary IPv4 address: the traffic that arrived, what was delivered to the VPS and what the filter stopped. It returns a time series and the attacks seen in the window. The filter measures only while filtering is on for the address. That is a session you started or an automatic networkMitigation.action: "scrub" on GET /api/v2/vps/{id}/ddos-scrubbing. During a blackhole nothing reaches the filter. Nothing is measured then. Measurements arrive once a minute and are kept for 35 days. They count every packet, not a sample. Stopped traffic also includes the connection attempts the filter answers for the server. A step with null rates was not measured. It does not mean there was no traffic. An attack starts when attack traffic averages at least 2,000 packets per second or 20 Mbps over a minute. It ends after 15 minutes under 500 packets per second and 5 Mbps.
Authentication: An API key with the scope read:vm. About keys and scopes
Request
Path parameters
idstringrequiredvps_…).Query parameters
timeframestringhour. Aliases 1h, 24h, 1d, 7d and 30d are accepted. Other values are rejected with 400 invalid_request. One of hour, day, week, month. Default "hour".Example
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/ddos-scrubbing/traffic" \ -H "Authorization: Bearer $HOSTUP_API_KEY"Responses
200 DDoS filtering measurements for the window.
{ "id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3", "ip": "192.0.2.10", "timeframe": "hour", "telemetry": { "available": true, "reason": null }, "window": { "startAt": "2026-10-06T09:31:00.000Z", "endAt": "2026-10-06T10:31:00.000Z", "sampleCount": 60, "aggregationWindowSeconds": 60 }, "lastMeasuredAt": "2026-10-06T10:30:00.000Z", "current": { "recordedAt": "2026-10-06T10:29:00.000Z", "inboundMbps": 6.712, "deliveredMbps": 6.105, "stoppedMbps": 0.607, "inboundPps": 2140.5, "deliveredPps": 1012.3, "stoppedPps": 1128.2 }, "summary": { "totalInboundGb": 4.318, "totalDeliveredGb": 2.61, "totalStoppedGb": 1.708, "inboundPacketCount": 31845210, "deliveredPacketCount": 3711004, "stoppedPacketCount": 28134206, "peakStoppedMbps": 48.2, "peakStoppedPps": 71350 }, "samples": [ { "recordedAt": "2026-10-06T09:31:00.000Z", "inboundMbps": 5.904, "deliveredMbps": 5.899, "stoppedMbps": 0.005, "inboundPps": 960.2, "deliveredPps": 952.1, "stoppedPps": 8.1 }, { "recordedAt": "2026-10-06T09:32:00.000Z", "inboundMbps": null, "deliveredMbps": null, "stoppedMbps": null, "inboundPps": null, "deliveredPps": null, "stoppedPps": null } ], "attacks": [ { "startedAt": "2026-10-06T09:47:00.000Z", "endedAt": "2026-10-06T10:04:00.000Z", "status": "ended", "endReason": "attack_stopped", "peakStoppedMbps": 48.2, "peakStoppedPps": 71350, "stoppedPacketCount": 28102877, "stoppedGb": 1.706, "vectors": [ { "type": "syn_flood", "sharePercent": 83.2 }, { "type": "udp_flood", "sharePercent": 16.8 } ], "attackedPorts": [ 443 ], "blockedSenderCount": 1071 } ]}Response fields
idstringipstring or nulltimeframestringhour, day, week, month.telemetryobjectavailablebooleanreasonstring or nullwindowobjectstartAtstringendAtstringsampleCountintegersamples.aggregationWindowSecondsintegerlastMeasuredAtstring or nullcurrentobject or nullsummaryobjecttotalInboundGbnumber or nulltotalDeliveredGbnumber or nulltotalStoppedGbnumber or nullinboundPacketCountintegerdeliveredPacketCountintegerstoppedPacketCountintegerpeakStoppedMbpsnumber or nullpeakStoppedPpsnumber or nullsamplesarray of objectwindow.startAt to window.endAt, oldest first. A step in which nothing was measured has null rates.recordedAtstringinboundMbpsnumber or nulldeliveredMbpsnumber or nullstoppedMbpsnumber or nullinboundPpsnumber or nulldeliveredPpsnumber or nullstoppedPpsnumber or nullattacksarray of objectstartedAtstringendedAtstring or nullstatusstringongoing, ended.endReasonstring or nullattack_stopped: the attack traffic went away. filtering_ended: filtering was switched off while the attack was still running. Its real end was not observed then. Null while ongoing. One of attack_stopped, filtering_ended.peakStoppedMbpsnumber or nullpeakStoppedPpsnumber or nullstoppedPacketCountintegerstoppedGbnumber or nullvectorsarray of objecttypestringsyn_flood, tcp_flood, udp_flood, fragmented_packets, icmp_flood, repeated_pattern, invalid_packets, other_protocols.sharePercentnumberattackedPortsarray of integerblockedSenderCountinteger or nullErrors
Errors are Problem Details with a stable code. Branch on the code, not on the text.
| 400 | Invalid request. The response body is an RFC 7807 Problem Details document. |
| 401 | Unauthorized. Authentication is required. |
| 403 | Forbidden. The caller lacks a required scope or does not own the resource. |
| 404 | Not found. The resource does not exist or is not owned by the caller; code is vps_not_found. |
| 429 | Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. |
| 500 | Internal error. Retry later or contact support if the issue persists. |