Create

API Reference

GPU Droplets

Floating IPs

Actions

Initiate a Floating IP Action

client.gpuDroplets.floatingIPs.actions.create(stringfloatingIP, ActionCreateParamsbody, RequestOptionsoptions?): ActionCreateResponse { action }

post/v2/floating_ips/{floating_ip}/actions

To initiate an action on a floating IP send a POST request to /v2/floating_ips/$FLOATING_IP/actions. In the JSON body to the request, set the type attribute to on of the supported action types:

Action	Details
assign	Assigns a floating IP to a Droplet
unassign	Unassign a floating IP from a Droplet

ParametersExpand Collapse

floatingIP: string

ActionCreateParams = FloatingIPActionUnassign | FloatingIPActionAssign

ActionCreateParamsBase { type }

type: "assign" | "unassign"

The type of action to initiate for the floating IP.

Accepts one of the following:

"assign"

"unassign"

FloatingIPActionUnassign extends ActionCreateParamsBase { type }

FloatingIPActionAssign extends ActionCreateParamsBase { type }

ReturnsExpand Collapse

ActionCreateResponse { action }

action?: Action { project_id }

project_id?: string

The UUID of the project to which the reserved IP currently belongs.

formatuuid

Initiate a Floating IP Action

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const action = await client.gpuDroplets.floatingIPs.actions.create('45.55.96.47', { type: 'assign' });

console.log(action.action);

200 example

{
  "action": {
    "id": 72531856,
    "completed_at": "2015-11-12T17:51:14Z",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "name": "New York 3",
      "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-192gb"
      ],
      "slug": "nyc3"
    },
    "region_slug": "nyc3",
    "resource_id": 758604968,
    "resource_type": "floating_ip",
    "started_at": "2015-11-12T17:51:03Z",
    "status": "completed",
    "type": "assign_ip",
    "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"
  }
}

Returns Examples

200 example

{
  "action": {
    "id": 72531856,
    "completed_at": "2015-11-12T17:51:14Z",
    "region": {
      "available": true,
      "features": [
        "private_networking",
        "backups",
        "ipv6",
        "metadata"
      ],
      "name": "New York 3",
      "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-192gb"
      ],
      "slug": "nyc3"
    },
    "region_slug": "nyc3",
    "resource_id": 758604968,
    "resource_type": "floating_ip",
    "started_at": "2015-11-12T17:51:03Z",
    "status": "completed",
    "type": "assign_ip",
    "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988"
  }
}