Skip to content

List routed IPv6 pools and routes

GET /api/v2/routed-ipv6

Get the account-level routed IPv6 state. It lists your routed /48 pools with their routes, the VPSes a route can point to and the route sizes you can use. A routed /48 is an IPv6 range that belongs to your account. You route all of it, or /56 and /64 parts of it, to your VPSes.

Self-service allocation is available only when the account has no routed /48 yet. actions says what you can do next. A VPS can receive a route when destinations[].actions.canReceiveRoute.allowed is true. That needs an active VPS with IPv6 turned on.

Authentication: An API key with the scopes read:network and read:vm. About keys and scopes

Example

GET /api/v2/routed-ipv6
curl "https://cloud.hostup.se/api/v2/routed-ipv6" \
-H "Authorization: Bearer $HOSTUP_API_KEY"

Responses

200 Your routed IPv6 pools, routes and possible destinations.

Response 200
{
"available": true,
"reason": null,
"allowedPrefixLengths": [
48,
56,
64
],
"pools": [
{
"id": "ripv6_01hxa3b4c5d6e7f8g9h0j1k2m3",
"parentCidr": "2001:db8:1000::/48",
"prefixLength": 48,
"status": "active",
"allocatedAt": "2026-06-15T12:00:00.000Z",
"updatedAt": "2026-06-15T12:00:00.000Z",
"routes": [
{
"id": "ripv6rt_01hxa3b4c5d6e7f8g9h0j1k2m4",
"prefix": "2001:db8:1000:10::/64",
"prefixLength": 64,
"nextHop": "2001:db8::10",
"label": "web subnet",
"vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m5",
"vpsName": "web-01",
"status": "active",
"allocatedAt": "2026-06-15T12:01:00.000Z",
"updatedAt": "2026-06-15T12:01:00.000Z",
"actions": {
"canDelete": {
"allowed": true,
"reason": null
}
}
}
],
"actions": {
"canCreateRoute": {
"allowed": true,
"reason": null
},
"canRelease": {
"allowed": false,
"reason": "Remove routed subnets before releasing this /48."
}
}
}
],
"destinations": [
{
"vpsId": "vps_01hxa3b4c5d6e7f8g9h0j1k2m5",
"name": "web-01",
"hostname": "web-01.example.com",
"primaryIp": "192.0.2.10",
"nextHop": "2001:db8::10",
"serviceStatus": "active",
"actions": {
"canReceiveRoute": {
"allowed": true,
"reason": null
}
}
}
],
"actions": {
"canAllocatePool": {
"allowed": false,
"reason": "This account already has a routed /48."
},
"canCreateRoute": {
"allowed": true,
"reason": null
}
}
}
Response fields
availableboolean
reasonstring or null
allowedPrefixLengthsarray of integer
poolsarray of object
idstring
parentCidrstring
prefixLengthinteger
One of 48.
statusstring
One of active.
allocatedAtstring or null
updatedAtstring or null
routesarray of object
idstring
prefixstring
prefixLengthinteger
One of 48, 56, 64.
nextHopstring
labelstring or null
vpsIdstring
vpsNamestring
statusstring
One of active.
allocatedAtstring or null
updatedAtstring or null
actionsobject
canDeleteobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null
actionsobject
canCreateRouteobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null
canReleaseobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null
destinationsarray of object
vpsIdstring
namestring
hostnamestring or null
The hostname set on the VPS. Null when none is set. Show name instead.
primaryIpstring or null
nextHopstring or null
serviceStatusstring
actionsobject
canReceiveRouteobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null
actionsobject
canAllocatePoolobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null
canCreateRouteobject
Whether one routed IPv6 action is available now.
allowedboolean
reasonstring or null

Errors

Errors are Problem Details with a stable code. Branch on the code, not on the text.

400Invalid request. The response body is an RFC 7807 Problem Details document.
401Unauthorized. Authentication is required.
403Forbidden. The caller lacks a required scope or does not own the resource.
404Not found. The resource does not exist or is not owned by the caller; code names the missing resource: routed_ipv6_pool_not_found, vps_not_found.
409Conflict. code is account_suspended.
429Rate limited. Retry after the limit resets. 429 responses include Retry-After seconds plus X-RateLimit-* headers.
500Internal error. Retry later or contact support if the issue persists.