Reserve floating IP

POST

/vps/floating-ips

Reserve a public address in a zone.

type=ipv4 (default) is billed from the next invoice cycle. type=ipv6 reserves a free /64 and is not invoiced. Optionally attach it to a VPS in the same zone.

Request

Authorization

API Key

Add parameter in header

API-key

Example:

API-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "location": "nl-ams01",
    "type": "ipv4",
    "vps_id": 123
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://mijn.host/api/v2/vps/floating-ips' \
--header 'Accept: application/json' \
--header 'User-Agent: my-application/1.0.0' \
--header 'API-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "location": "nl-ams01",
    "type": "ipv4",
    "vps_id": 123
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "status_description": "Floating IP reserved",
    "data": {
        "id": 1000,
        "ip": "185.1.2.3",
        "type": "ipv4",
        "location": "nl-ams01",
        "attached_vps_id": null,
        "attached_vps_name": null,
        "reserved": true,
        "cancelled": false
    }
}

🟠400Wrong request method

🟠400SSL connection is required

🟠401No valid API key set

🟠401API key has expired

🟠401Remote IP address is not found in the API key whitelist

🔴500Error

Modified at 2026-09-07 09:05:53

List floating IPs

Attach floating IP