Give Feedback

dots.v2.floating_ips.post()

Generated on 27 Oct 2026 from DoTs version v1.21.0

Copy page as Markdown View page as Markdown

Usage

client.v2.floating_ips.post(body: Floating_ip_createMember1 | Floating_ip_createMember2, requestConfiguration?: RequestConfiguration<object>): Promise<undefined | Floating_ipsPostResponse>

Description

On creation, a floating IP must be either assigned to a Droplet or reserved to a region.

To create a new floating IP assigned to a Droplet, send a POST request to /v2/floating_ips with the droplet_id attribute.
To create a new floating IP reserved to a region, send a POST request to /v2/floating_ips with the region attribute.

Parameters

body object required

Show child properties

dropletId integer optional

Example: 2457247

The ID of the Droplet that the floating IP will be assigned to.

region string optional

Example: nyc3

The slug identifier for the region the floating IP will be reserved to.

projectId string optional

Example: 746c6152-2fa2-11ed-92d3-27aaa54e4988

The UUID of the project to which the floating IP will be assigned.

Request Sample

Show Request Sample

import { FetchRequestAdapter } from "@microsoft/kiota-http-fetchlibrary";
import {
    createDigitalOceanClient,
    DigitalOceanApiKeyAuthenticationProvider,
} from "@digitalocean/dots";

const authProvider = new DigitalOceanApiKeyAuthenticationProvider(process.env.DIGITALOCEAN_TOKEN!);
const adapter = new FetchRequestAdapter(authProvider);
const client = createDigitalOceanClient(adapter);

const response = await client.v2.floating_ips.post({
    dropletId: 2457247,
});

Response Example

Show Response Example

{
  "floating_ip": {
    "ip": "45.55.96.47",
    "droplet": null,
    "region": {
      "name": "New York 3",
      "slug": "nyc3",
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata",
        "install_agent",
        "storage",
        "image_transfer"
      ],
      "available": true,
      "sizes": [
        "s-1vcpu-1gb",
        "s-1vcpu-2gb",
        "s-1vcpu-3gb",
        "s-2vcpu-2gb",
        "s-3vcpu-1gb",
        "s-2vcpu-4gb",
        "s-4vcpu-8gb",
        "s-6vcpu-16gb",
        "s-8vcpu-32gb",
        "s-12vcpu-48gb",
        "s-16vcpu-64gb",
        "s-20vcpu-96gb",
        "s-24vcpu-128gb",
        "s-32vcpu-192g"
      ]
    },
    "locked": true,
    "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"
  },
  "links": {
    "droplets": [
      {
        "id": 213939433,
        "rel": "droplet",
        "href": "https://api.digitalocean.com/v2/droplets/213939433"
      }
    ],
    "actions": [
      {
        "id": 1088924622,
        "rel": "assign_ip",
        "href": "https://api.digitalocean.com/v2/actions/1088924622"
      }
    ]
  }
}

More Information

See /v2/floating_ips in the API reference for additional detail on responses, headers, parameters, and more.