Skip to content

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

idstringrequired
The VPS ID (vps_…).

Query parameters

timeframestring
Window to load. Defaults to hour. 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

GET /api/v2/vps/{id}/ddos-scrubbing/traffic
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.

Response 200
{
"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
idstring
Public VPS ID.
ipstring or null
The VPS primary IPv4 address the measurements are for. Null when the VPS has none.
timeframestring
The window that was returned. One of hour, day, week, month.
telemetryobject
Whether the DDoS filter measured anything for this VPS in the window.
availableboolean
True when at least one step in the window was measured.
reasonstring or null
Why nothing is shown. Null when measurements are available. Unavailable means not measured, never that no traffic occurred.
windowobject
The time span the samples cover.
startAtstring
Start of the first step.
endAtstring
End of the step in progress.
sampleCountinteger
Number of entries in samples.
aggregationWindowSecondsinteger
Length of one step: 60 for hour, 300 for day, 1800 for week, 7200 for month.
lastMeasuredAtstring or null
End of the newest measured minute in the last 24 hours. Null when there is none. Measurements arrive once a minute while filtering is active.
currentobject or null
The newest measured minute. Null when the newest measurement is more than five minutes old. That is always the case while filtering is off.
summaryobject
Totals over the measured steps of the window.
totalInboundGbnumber or null
Volume that arrived for the address, in decimal gigabytes. Null when nothing was measured or only packets were counted.
totalDeliveredGbnumber or null
Volume passed on to the VPS, in decimal gigabytes.
totalStoppedGbnumber or null
Volume the filter kept away from the VPS, in decimal gigabytes.
inboundPacketCountinteger
Packets that arrived for the address.
deliveredPacketCountinteger
Packets passed on to the VPS.
stoppedPacketCountinteger
Packets the filter kept away from the VPS.
peakStoppedMbpsnumber or null
Highest ten-second rate of stopped traffic in the window, in megabits per second.
peakStoppedPpsnumber or null
Highest ten-second rate of stopped packets per second in the window.
samplesarray of object
One entry per step from window.startAt to window.endAt, oldest first. A step in which nothing was measured has null rates.
recordedAtstring
Start of the step.
inboundMbpsnumber or null
Traffic that arrived for the address, in megabits per second. Null when the step was not measured or only packets were counted.
deliveredMbpsnumber or null
Traffic passed on to the VPS, in megabits per second.
stoppedMbpsnumber or null
Traffic the filter kept away from the VPS (arrived minus delivered), in megabits per second.
inboundPpsnumber or null
Packets per second that arrived for the address. Null when the step was not measured.
deliveredPpsnumber or null
Packets per second passed on to the VPS.
stoppedPpsnumber or null
Packets per second the filter kept away from the VPS.
attacksarray of object
Attacks that were ongoing or ended inside the window, newest first, at most 20.
startedAtstring
Start of the first minute with attack traffic.
endedAtstring or null
End of the last minute with attack traffic. Null while the attack is ongoing.
statusstring
“ongoing” until attack traffic has been absent for 15 minutes or filtering is switched off. One of ongoing, ended.
endReasonstring or null
attack_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 null
Highest rate of stopped traffic during the attack, in megabits per second. Null when only packets were counted.
peakStoppedPpsnumber or null
Highest rate of stopped packets per second during the attack.
stoppedPacketCountinteger
Packets the filter kept away from the VPS during the attack.
stoppedGbnumber or null
Volume the filter kept away from the VPS during the attack, in decimal gigabytes. Null when only packets were counted.
vectorsarray of object
What the attack consisted of, largest share first. Shares under 1 % are left out.
typestring
“syn_flood”: fake connection attempts. “tcp_flood”: TCP packets that belong to no connection (ACK and RST floods). “udp_flood”: UDP above the filter’s limit. “fragmented_packets”: IP or UDP fragments. “icmp_flood”: ICMP above the limit. “repeated_pattern”: senders blocked for repeating an attack pattern. “invalid_packets”: malformed packets or impossible TCP flags. “other_protocols”: other IP protocols above the limit. One of syn_flood, tcp_flood, udp_flood, fragmented_packets, icmp_flood, repeated_pattern, invalid_packets, other_protocols.
sharePercentnumber
Share of the attack’s packets, 0 to 100.
attackedPortsarray of integer
Destination ports the filter identified as targets, most frequent first. Empty when none were identified.
blockedSenderCountinteger or null
Sending addresses the filter blocked for repeating the attack pattern. Null when none were reported.

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code is vps_not_found.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.