## PUT /api/v2/vps/{id}/metadata

**Update VPS display metadata**

Update customer-owned display labels for one VPS. These labels do not change the real VPS hostname or operating system; canonical fields remain on `name`, `hostname`, and `operatingSystem`. Send `displayName` to set or clear the displayed server name. Send `operatingSystemName` together with `operatingSystemSourceName` to override the displayed OS label for the current upstream OS; sending the same value as the source clears the OS override.

### 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: `write:vm`
- `Content-Type`: application/json

### 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 Body

- `displayName` (string, optional, nullable): Customer-facing VPS label. Send null or an empty string to clear it. Example: `Production DB`
- `operatingSystemName` (string, optional, nullable): Customer-facing OS label. Send null or the same value as `operatingSystemSourceName` to clear it. Example: `Debian 13`
- `operatingSystemSourceName` (string, optional, nullable): Current upstream OS display name the override is based on. Required when setting `operatingSystemName`. Example: `Debian 12`

### Request Examples

#### Set display name

```bash
curl -X PUT "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Production DB"
  }'
```

```json
{
  "displayName": "Production DB"
}
```

#### Set displayed OS name

```bash
curl -X PUT "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "operatingSystemName": "Debian 13",
    "operatingSystemSourceName": "Debian 12"
  }'
```

```json
{
  "operatingSystemName": "Debian 13",
  "operatingSystemSourceName": "Debian 12"
}
```

#### Clear display name

```bash
curl -X PUT "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": null
  }'
```

```json
{
  "displayName": null
}
```

### Response Schema

- `customerMetadata` (object, required)
- `customerMetadata.displayName` (string, required, nullable): Nullable (may be null when not applicable). Example: `Production DB`
- `customerMetadata.operatingSystemName` (string, required, nullable): Nullable (may be null when not applicable). Example: `Debian 13`
- `customerMetadata.operatingSystemSourceName` (string, required, nullable): Nullable (may be null when not applicable). Example: `Debian 12`
- `customerMetadata.updatedAt` (string, required, nullable): Nullable (may be null when not applicable). Example: `2026-06-30T10:00:00.000Z`

### Responses

#### 200 - Metadata updated.
```json
{
  "customerMetadata": {
    "displayName": "Production DB",
    "operatingSystemName": "Debian 13",
    "operatingSystemSourceName": "Debian 12",
    "updatedAt": "2026-06-30T10:00:00.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/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-06-30T10:00:00.000Z",
  "errors": [
    {
      "pointer": "/operatingSystemSourceName",
      "detail": "`operatingSystemSourceName` is required when setting `operatingSystemName`.",
      "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/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-06-30T10:00:00.000Z"
}
```

#### 403 - Forbidden. The caller lacks a required scope or does not own the VPS.
```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/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-06-30T10:00:00.000Z"
}
```

#### 404 - Not found. The VPS 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/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/metadata",
  "requestId": "req_01hxa3b4c5d6e7f8g9h0j1k2m3",
  "timestamp": "2026-06-30T10:00:00.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"
}
```