compute

POST /v1/compute/servers/{serverId}/floating-ips

Reserve a floating IP and route it to a server.

All compute endpoints

All developer docs

Authentication

Send an API key as a bearer token. The key must carry the billing.payment.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/compute/servers/{serverId}/floating-ips \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "family": <string<ipv4, ipv6>> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Chargeable. The address's monthly price is folded into the machine's hourly rate from the next hour and stays there until it is released, so it is only offered on pay-by-the-hour machines. Quote it first with quoteComputeServerFloatingIp. The machine does not answer on the address until its operating system is told the address exists; a client shows the commands beside the address. Requires billing.payment.manage.

Parameters

NameTypeRequiredWhat it is
serverId (path)UuidYesThe server's id, as listComputeServers reports it. Ours (UUIDv7), minted when the order row was written — never the provider's own identifier for the machine.

Request body

NameTypeRequiredWhat it is
familystring<ipv4, ipv6>Yes

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
server_idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
familystring<ipv4, ipv6>Yes
statusstring<pending, active, released, failed>Yes
addressstringYesThe address, or the routed /64 for IPv6. Blank until reserved.
home_zonestringYes
monthly_price_minorintegerYesWhat the customer pays per month, in minor units of currency.
currencystringYes
messagestringYes
created_atstringYes

Errors this endpoint can return

401 · 403 · 404 · 422 · 429 · 503