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

**Get DDoS scrubbing status**

Get the on-demand DDoS scrubbing state for the VPS primary IP. If `available` is false, `reason` explains why scrubbing cannot be used. When a session is active, `durationSeconds` and `expiresAt` describe how long it runs. `networkMitigation` reports any network-level mitigation currently applied to the IP — including automatic attack responses. `networkMitigation.action` `"blackhole"` means all internet traffic to the IP is temporarily dropped (the VPS is unreachable from outside until `expiresAt`); `"scrub"` means traffic is filtered but services keep working. `networkMitigation.status` `"unknown"` means the mitigation state could not be verified right now — do not treat it as "no mitigation". Use `POST /api/v2/vps/{id}/ddos-scrubbing` to enable a session and `DELETE /api/v2/vps/{id}/ddos-scrubbing` to end it early.

### 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}`: Get VPS details

### Headers

- `Accept`: application/json
- `Authorization`: Bearer YOUR_API_KEY
- Required API scope: `read:vm`

### Parameters

- `id` (path, string, required): Public VPS ID. Get it from `GET /api/v2/vps` `data[].id`. Do not invent this value; use the exact ID returned by the referenced API response. Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`

### Request Example

```bash
curl -X GET "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/ddos-scrubbing" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `available` (boolean, required): Whether on-demand DDoS scrubbing can be used on this VPS.
- `reason` (string, required, nullable): Why scrubbing is unavailable, or null when it is available.
- `ip` (string, required, nullable): IP address the scrubbing state applies to.
- `active` (boolean, required): Whether an on-demand scrubbing session is currently active.
- `durationSeconds` (integer, required, nullable): Duration of the active session in seconds, or null when no session is active.
- `createdAt` (string, required, nullable): When the active session started, or null.
- `expiresAt` (string, required, nullable): When the active session ends, or null.
- `networkMitigation` (object, required): Any network-level DDoS mitigation currently applied to the VPS IP, including automatic attack responses that are not part of an on-demand session.
- `networkMitigation.status` (string, required): "active" when a mitigation is applied, "none" when verified clear, "unknown" when the state could not be verified right now (never assume "unknown" means clear).
  Allowed values: active, none, unknown
- `networkMitigation.action` (string, required, nullable): "blackhole": all internet traffic to the IP is dropped until the mitigation ends — the VPS appears offline from outside. "scrub": traffic is filtered; services keep working. Null when status is not "active".
  Allowed values: blackhole, scrub
- `networkMitigation.automatic` (boolean, required, nullable): True when the mitigation was applied automatically in response to an attack; false when it is the customer's own on-demand scrubbing session. Null when unknown.
- `networkMitigation.createdAt` (string, required, nullable): When the mitigation started, or null.
- `networkMitigation.expiresAt` (string, required, nullable): When the mitigation automatically ends, or null.

### Responses

#### 200 - The current DDoS scrubbing state.
```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 body failed validation.",
  "code": "invalid_request",
  "instance": "/api/v2/resource",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-04-27T12:34:56.000Z",
  "errors": [
    {
      "pointer": "/items/0/domainName",
      "detail": "`domainName` is required.",
      "code": "invalid_request"
    }
  ]
}
```

#### 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.
```json
{
  "type": "https://developer.hostup.se/errors/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource could not be found.",
  "code": "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": "Too many requests. Retry after the limit resets.",
  "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"
}
```