IP pools and regions

The pools floating IPs come from, the region each one serves, and how to see what is in stock.

View as Markdown

In the dashboard

/dashboard/order/floating-ips

A pool is a set of addresses we announce from one region. Every floating IP comes from a pool, and traffic to the address enters our network in that region. Choose a pool in the region where the instance or server you attach the address to runs.

Choose a pool when you order

Section titled Choose a pool when you order

There is no separate list of pools. The order page chooses the pool. In the dashboard, go to Floating IPs and select Order floating IP. Under Region, the order page lists the pools that sell the size you chose, grouped by region.

What you see	What it means
Region heading	The region's name, such as `Frankfurt`.
Pool card	One pool, with its flag, its name and its airport code such as `FRA`. We start with a pool in your own region.
`Sold out`	The pool has no address of this size left, and its card cannot be chosen.
This size is out of stock	No pool has an address of this size. Choose another size or check back later. Addresses return as other customers release them.

Choosing a size changes the pools on offer, because a pool sells a size only when it has addresses of that size. Order a floating IP describes the whole page. For a larger block than the order page offers, contact support.

Stock changes as customers order and release addresses. The order page shows what is in stock when it loads.

Sizes

Section titled Sizes

Prefix	What you get
`/32`	One IPv4 address.
`/128`	One IPv6 address. It attaches to Cloud Compute instances only.
`/29` to `/24`	An IPv4 subnet. How subnets work lists how many usable hosts each size has.

We sell no IPv6 subnets. A pool sells IPv6 addresses only when it has IPv6 space, so fewer regions offer them than IPv4. Subnets appear only when the catalogue sells them, so a region can offer single addresses and no subnets.

You do not order the IPv6 /64 that comes with a Cloud Compute instance. The instance gets it from the pool of its own location, as Add IPv6 to an instance describes.

The pools API

Section titled The pools API

GET /api/v1/client/ips/pools lists the pools with stock of one size.

Query parameter	Default	Values
`version`	`ipv4`	`ipv4`, or `ipv6` for IPv6 addresses.
`prefix_len`	single addresses	For IPv4, `32` for single addresses, or `24` to `29` for subnets of that size. For IPv6, `128`, the only size.
`region`	every region	An airport code in lower case, such as `fra`.

Shell

curl "https://api.coritan.com/api/v1/client/ips/pools?prefix_len=29" \
  -H "Authorization: Bearer $CORITAN_TOKEN"

For IPv6 addresses, ask for version=ipv6, such as ?version=ipv6&region=iad. The answer lists the pools that can give out an IPv6 address, with version set to ipv6 and prefix_len to 128.

JSON

{
  "pools": [
    {
      "id": 4,
      "uuid": "0b6c2f4e-6c4a-4d4e-9d61-1f1a2b3c4d5e",
      "name": "Frankfurt 1",
      "slug": "frankfurt-1",
      "region": "fra",
      "country_code": "DE",
      "geo_label": "Frankfurt",
      "preference_rank": 10,
      "available": true,
      "version": "ipv4",
      "prefix_len": 29
    }
  ]
}

Field	Meaning
`id`	The pool's ID. Send it as `config.pool_id` when you order.
`name`, `slug`	The pool's name as the dashboard shows it, and a short form of it.
`region`	The region's airport code.
`country_code`	The two-letter code of the pool's country.
`geo_label`	The region's name.
`preference_rank`	The order to prefer pools within a region, lowest first.
`available`	`true` when the pool has stock of the size you asked for.
`version`, `prefix_len`	The size you asked for.

Only pools with stock of the size appear, and the response gives no counts.

Response	When
`200` with `"pools": []`	No pool has stock of that size, or the catalogue does not sell subnets.
`422` with `version must be ipv4 or ipv6`	`version` is another word.
`422` with a message that starts `prefix_len must be one of`	`prefix_len` is not `32` or `24` to `29` for IPv4.
`422` with a message that starts `An IPv6 order takes prefix_len 128`	`version` is `ipv6` and `prefix_len` is not `128`.

The Floating IPs API reference lists every field.

API operations on this page

Method	Path	What it does
`GET`	`/api/v1/client/ips/pools`	Active geo pools with sellable stock for ordering