Update VPS display metadata

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

Update customer-owned display labels for one VPS.

A changed displayName is also synchronized to the customer-visible service name used on future invoices.

The technical hostname remains a valid DNS-style name managed by the server-name flow.

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.

VPS Services VM

Authentication

Required API scope: write:vm

Authenticate with an API key in the Authorization: Bearer <token> header.

Context

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

Path Parameters

id string required Example: vps_01hxa3b4c5d6e7f8g9h0j1k2m3

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.

Headers

Authorization Bearer <token>

Accept application/json

Content-Type application/json

Body

required

application/json

displayName string · nullable · Example: Production DB

Customer-facing VPS and future-invoice label. Send null or an empty string to clear it and return to the technical hostname.

operatingSystemName string · nullable · Example: Debian 13

Customer-facing OS label. Send null or the same value as operatingSystemSourceName to clear it.

operatingSystemSourceName string · nullable · Example: Debian 12

Current upstream OS display name the override is based on. Required when setting operatingSystemName.

Responses

200 Metadata updated. 1 field

customerMetadata object required

customerMetadata.displayName string · nullable required · Example: Production DB

Nullable: may be null when not applicable.

customerMetadata.operatingSystemName string · nullable required · Example: Debian 13

Nullable: may be null when not applicable.

customerMetadata.operatingSystemSourceName string · nullable required · Example: Debian 12

Nullable: may be null when not applicable.

customerMetadata.updatedAt string · nullable required · Example: 2026-06-30T10:00:00.000Z

Nullable: may be null when not applicable.

400 Invalid request. The response body is an RFC 7807 Problem Details document. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

401 Unauthorized. Authentication is required. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

403 Forbidden. The caller lacks a required scope or does not own the VPS. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

404 Not found. The VPS does not exist or is not owned by the caller. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

429 Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

500 Internal error. Retry later or contact support if the issue persists. 10 fields

type string · Example: https://developer.hostup.se/errors/invalid_request

title string · Example: Validation failed

status integer · Example: 400

detail string · Example: The request body failed validation.

code string · Example: invalid_request

Stable machine-readable code. Branch on this field, not on detail.

instance string · Example: /api/v2/orders

requestId string · Example: req_01hxa3b4c5d6e7f8g9h0j1k2m3

timestamp string · Example: 2026-04-27T12:34:56.000Z

errors array<object>

Field-level validation errors when code is invalid_request.

errors[].pointer string required · Example: /items/0/eppCode

errors[].detail string required · Example: `eppCode` is required for this transfer.

errors[].code string required · Example: missing_required

extensions object

PUT https://cloud.hostup.se/api/v2/vps/{id}/metadata

For AI assistants

View as Markdown

Scenario

cURL

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"
  }'

Response

{
  "customerMetadata": {
    "displayName": "Production DB",
    "operatingSystemName": "Debian 13",
    "operatingSystemSourceName": "Debian 12",
    "updatedAt": "2026-06-30T10:00:00.000Z"
  }
}

{
  "type": "object",
  "properties": {
    "customerMetadata": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "nullable": true
        },
        "operatingSystemName": {
          "type": "string",
          "nullable": true
        },
        "operatingSystemSourceName": {
          "type": "string",
          "nullable": true
        },
        "updatedAt": {
          "type": "string",
          "nullable": true
        }
      }
    }
  }
}

Request Body Set display name

{
  "displayName": "Production DB"
}