## GET /api/v2/vps/{id}/metrics

**Get VPS metrics**

Return time-series CPU, memory, disk, and network metrics for one VPS. Get `{id}` from `GET /api/v2/vps` `data[].id`. Use `timeframe` to choose the sampled window; canonical values are `hour`, `day`, `week`, `month`, and `year`. Common duration aliases such as `1h`, `24h`, `1d`, `7d`, `30d`, and `1y` are accepted and normalized in the response. Units are encoded in field names.

### Related Endpoints

- `GET /api/v2/vps/{id}`: Get VPS details
- `GET /api/v2/vps/{id}/iso`: List VPS ISO media
- `GET /api/v2/vps/{id}/disks`: List VPS disks

### Headers

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

### Parameters

- `timeframe` (query, string): Metrics window to load. Defaults to `hour` when omitted. Use canonical values where possible; aliases `1h`, `24h`, `1d`, `7d`, `30d`, and `1y` are accepted.
  Allowed values: hour, day, week, month, year
- `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/metrics" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Response Schema

- `id` (string, optional) Example: `vps_01hxa3b4c5d6e7f8g9h0j1k2m3`
- `timeframe` (string, optional) Example: `hour`
  Allowed values: hour, day, week, month, year
- `samples` (array<object>, optional)
- `samples[].recordedAt` (string, required) Example: `2026-04-27T12:00:00.000Z`
- `samples[].cpuUsagePercent` (number, required) Example: `12.5`
- `samples[].memoryUsagePercent` (number, required) Example: `42.5`
- `samples[].diskReadMbPerSecond` (number, required) Example: `1.05`
- `samples[].diskWriteMbPerSecond` (number, required) Example: `0.52`
- `samples[].networkInboundKbPerSecond` (number, required) Example: `2048`
- `samples[].networkOutboundKbPerSecond` (number, required) Example: `4096`
- `summary` (object, optional)
- `summary.avgDiskReadMbPerSecond` (number,null, required) Example: `0.8`
- `summary.avgDiskWriteMbPerSecond` (number,null, required) Example: `0.4`
- `summary.peakDiskReadMbPerSecond` (number,null, required) Example: `2.1`
- `summary.peakDiskWriteMbPerSecond` (number,null, required) Example: `1.3`
- `summary.totalDiskReadGb` (number,null, required) Example: `0.75`
- `summary.totalDiskWriteGb` (number,null, required) Example: `0.42`
- `summary.totalNetworkInboundGb` (number,null, required) Example: `1.25`
- `summary.totalNetworkOutboundGb` (number,null, required) Example: `2.5`
- `summary.avgNetworkInboundKbPerSecond` (number,null, required) Example: `2048`
- `summary.avgNetworkOutboundKbPerSecond` (number,null, required) Example: `4096`
- `summary.peakNetworkInboundKbPerSecond` (number,null, required) Example: `8192`
- `summary.peakNetworkOutboundKbPerSecond` (number,null, required) Example: `16384`

### Responses

#### 200 - VPS metrics.
```json
{
  "id": "vps_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timeframe": "hour",
  "samples": [
    {
      "recordedAt": "2026-04-27T12:00:00.000Z",
      "cpuUsagePercent": 12.5,
      "memoryUsagePercent": 42.5,
      "diskReadMbPerSecond": 1.05,
      "diskWriteMbPerSecond": 0.52,
      "networkInboundKbPerSecond": 2048,
      "networkOutboundKbPerSecond": 4096
    }
  ],
  "summary": {
    "avgDiskReadMbPerSecond": 0.8,
    "avgDiskWriteMbPerSecond": 0.4,
    "peakDiskReadMbPerSecond": 2.1,
    "peakDiskWriteMbPerSecond": 1.3,
    "totalDiskReadGb": 0.75,
    "totalDiskWriteGb": 0.42,
    "totalNetworkInboundGb": 1.25,
    "totalNetworkOutboundGb": 2.5,
    "avgNetworkInboundKbPerSecond": 2048,
    "avgNetworkOutboundKbPerSecond": 4096,
    "peakNetworkInboundKbPerSecond": 8192,
    "peakNetworkOutboundKbPerSecond": 16384
  }
}
```

#### 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"
}
```