Allocate or refresh routed IPv6

Allocate routed IPv6 for a VPS, or refresh the suggested next hop. The body is optional; omitted or {} means action: allocate. rackId is optional and capped at 50 characters.

VPS Services VM

Authentication

Required API scope: write:network

Use Authorization: Bearer <token> for API keys. Dashboard sessions may also use hostup_session.

Context

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

Accept Example
Content-Type Example

Body

required
application/json
action string · enum · Example: allocate
allocate
refresh_next_hop
rackId string · Example: stockholm-a

Responses

200 Routed IPv6 refreshed.
available boolean required · Example: true
reason stringnull required · Example: null
parentCidr stringnull required · Example: 2001:db8:42::/48
prefixLength numbernull required · Example: 64
cooldownDays numbernull required · Example: 30
maxPerVm numbernull required · Example: 1
suggestedNextHop stringnull required · Example: 2001:db8:42::1
created booleannull required · Example: true
allocation object | null required · Example: null
allocation.id stringnull required · Example: ripv6_01hxa3b4c5d6e7f8g9h0j1k2m3
allocation.prefix stringnull required · Example: 2001:db8:42:100::/64
allocation.prefixLength numbernull required · Example: 64
allocation.nextHop stringnull required · Example: 2001:db8:42::1
allocation.status stringnull required · Example: active
allocation.allocatedAt stringnull required · Example: 2026-04-27T12:00:00.000Z
allocation.releasedAt stringnull required · Example: null
allocation.cooldownUntil stringnull required · Example: null
allocation.createdAt stringnull required · Example: 2026-04-27T12:00:00.000Z
allocation.updatedAt stringnull required · Example: 2026-04-27T12:00:00.000Z
201 Routed IPv6 allocated.
available boolean required · Example: true
reason stringnull required · Example: null
parentCidr stringnull required · Example: 2001:db8:42::/48
prefixLength numbernull required · Example: 64
cooldownDays numbernull required · Example: 30
maxPerVm numbernull required · Example: 1
suggestedNextHop stringnull required · Example: 2001:db8:42::1
created booleannull required · Example: true
allocation object | null required · Example: null
allocation.id stringnull required · Example: ripv6_01hxa3b4c5d6e7f8g9h0j1k2m3
allocation.prefix stringnull required · Example: 2001:db8:42:100::/64
allocation.prefixLength numbernull required · Example: 64
allocation.nextHop stringnull required · Example: 2001:db8:42::1
allocation.status stringnull required · Example: active
allocation.allocatedAt stringnull required · Example: 2026-04-27T12:00:00.000Z
allocation.releasedAt stringnull required · Example: null
allocation.cooldownUntil stringnull required · Example: null
allocation.createdAt stringnull required · Example: 2026-04-27T12:00:00.000Z
allocation.updatedAt stringnull required · Example: 2026-04-27T12:00:00.000Z
400 Invalid request. The response body is an RFC 7807 Problem Details document.
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.
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 resource.
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 resource does not exist or is not owned by the caller.
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.
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.
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
POST https://cloud.hostup.se/api/v2/vps/{id}/routed-ipv6
For AI assistants
View as Markdown
cURL
curl -X POST "https://cloud.hostup.se/api/v2/vps/vps_01hxa3b4c5d6e7f8g9h0j1k2m3/routed-ipv6" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "allocate"
  }'
Response
{
  "available": true,
  "reason": null,
  "parentCidr": "2001:db8:42::/48",
  "prefixLength": 64,
  "cooldownDays": 30,
  "maxPerVm": 1,
  "suggestedNextHop": "2001:db8:42::1",
  "created": true,
  "allocation": {
    "id": "ripv6_01hxa3b4c5d6e7f8g9h0j1k2m3",
    "prefix": "2001:db8:42:100::/64",
    "prefixLength": 64,
    "nextHop": "2001:db8:42::1",
    "status": "active",
    "allocatedAt": "2026-04-27T12:00:00.000Z",
    "releasedAt": null,
    "cooldownUntil": null,
    "createdAt": "2026-04-27T12:00:00.000Z",
    "updatedAt": "2026-04-27T12:00:00.000Z"
  }
}
Request Body Allocate routed IPv6
{
  "action": "allocate"
}