Skip to main content
POST
Allocate floating IP
Requires the IAM action network:CreateFloatingIP. See NETWORK permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Body

application/json
description
string
Example:

"Public IP for the web load balancer"

family
enum<string>
default:ipv4

Which family to allocate in. Fixed for the life of the address — it decides the pool the address comes from, the quota it counts against (floating_ips_v4 or floating_ips_v6) and the SKU it bills as. Omitted means ipv4.

Available options:
ipv4,
ipv6
Example:

"ipv6"

tags
object
health_check
object

An optional readiness check for the address's members. Omitted means none — the address behaves exactly as an ordinary floating IP.

visibility
enum<string>
default:public
Available options:
public,
private
subnet
string

Required for private floating IPs; subnet UUID or CRN in this account. Targets may be in other subnets of the same VPC.

Response

Floating IP allocated

floating_ip
object
required