## GET /api/v2/vps/{id}/ddos-scrubbing

**Get DDoS scrubbing status**

Get the DDoS scrubbing state of the VPS's primary IPv4 address. `available` says whether you can start scrubbing on this VPS. When it is false, `reason` says why. `active` is true while a session you started is running. `networkMitigation` shows any protection on the address right now, including the automatic response to an attack. With `action: "blackhole"` all traffic from the internet to the address is dropped. The VPS is unreachable from outside until `expiresAt`. With `action: "scrub"` traffic is filtered before it reaches the VPS. `status: "unknown"` means the state could not be checked. It does not mean that nothing is active. Start a session with [`POST /api/v2/vps/{id}/ddos-scrubbing`](/endpoints/vps-services/post-v2-vps-id-ddos-scrubbing/) and end it with [`DELETE /api/v2/vps/{id}/ddos-scrubbing`](/endpoints/vps-services/delete-v2-vps-id-ddos-scrubbing/).

### Related Endpoints

- `POST /api/v2/vps/{id}/ddos-scrubbing`: Enable DDoS scrubbing
- `DELETE /api/v2/vps/{id}/ddos-scrubbing`: Disable DDoS scrubbing
- `GET /api/v2/vps/{id}/ddos-scrubbing/traffic`: Get DDoS filtering measurements

### Headers

- `Authorization`: Bearer $HOSTUP_API_KEY
- Scope: `read:vm`

### Parameters

- `id` (path, string, required): The VPS ID (`vps_…`). Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

```bash
curl "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/ddos-scrubbing" \
  -H "Authorization: Bearer $HOSTUP_API_KEY"
```

### Response Schema

- `available` (boolean, required): Whether you can start scrubbing on this VPS.
- `reason` (string, required, nullable): Why scrubbing is not available. Null when it is.
- `ip` (string, required, nullable): The primary IPv4 address the state applies to. Null when the VPS has none.
- `active` (boolean, required): True while a scrubbing session you started is running.
- `durationSeconds` (integer, required, nullable): Always null on this read. The response to `POST` carries the session length.
- `createdAt` (string, required, nullable): When the running session started. Null without a session.
- `expiresAt` (string, required, nullable): When the running session ends. Null without a session and for always-on scrubbing.
- `networkMitigation` (object, required): Any protection on the address right now, including the automatic response to an attack.
- `networkMitigation.status` (string, required): `active` when protection is on. `none` when checked and clear. `unknown` when it could not be checked, which never means clear.
  Allowed values: active, none, unknown
- `networkMitigation.action` (string, required, nullable): `blackhole`: all internet traffic to the address is dropped. `scrub`: traffic is filtered before it reaches the VPS. Null unless `status` is `active`.
  Allowed values: blackhole, scrub
- `networkMitigation.automatic` (boolean, required, nullable): False for a session started from the client area or the API. True otherwise, for example the automatic response to an attack. Null when unknown.
- `networkMitigation.createdAt` (string, required, nullable): When it started. Null when unknown.
- `networkMitigation.expiresAt` (string, required, nullable): When it ends by itself. Null when it has no end or is unknown.

### Responses

#### 200 - DDoS scrubbing state of the VPS's primary IPv4 address.
```json
{
  "available": true,
  "reason": null,
  "ip": "192.0.2.10",
  "active": false,
  "durationSeconds": null,
  "createdAt": null,
  "expiresAt": null,
  "networkMitigation": {
    "status": "active",
    "action": "blackhole",
    "automatic": true,
    "createdAt": "2026-08-07T11:15:20.000Z",
    "expiresAt": "2026-08-07T12:15:20.000Z"
  }
}
```

#### 400 - Invalid request. The response body is an RFC 7807 Problem Details document.
```json
{
  "type": "https://developer.hostup.se/errors/invalid_request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The request is invalid.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 401 - Unauthorized. Authentication is required.
```json
{
  "type": "https://developer.hostup.se/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication is required.",
  "code": "unauthorized",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the resource.
```json
{
  "type": "https://developer.hostup.se/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The caller lacks a required scope or does not own the resource.",
  "code": "forbidden",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 404 - Not found. The resource does not exist or is not owned by the caller; `code` is `vps_not_found`.
```json
{
  "type": "https://developer.hostup.se/errors/vps_not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "vps_not_found",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 429 - Rate limited. Retry after the limit resets. 429 responses include `Retry-After` seconds plus `X-RateLimit-*` headers.
```json
{
  "type": "https://developer.hostup.se/errors/rate_limit_exceeded",
  "title": "Too many requests",
  "status": 429,
  "detail": "Rate limit exceeded. Please try again later.",
  "code": "rate_limit_exceeded",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```

#### 500 - Internal error. Retry later or contact support if the issue persists.
```json
{
  "type": "https://developer.hostup.se/errors/internal_error",
  "title": "Internal server error",
  "status": 500,
  "detail": "An unexpected error occurred. Retry later or contact support if the issue persists.",
  "code": "internal_error",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z"
}
```
