Retrieve

API Reference

GPU Droplets

Floating IPs

Actions

Retrieve an Existing Floating IP Action

client.gpuDroplets.floatingIPs.actions.retrieve(numberactionID, ActionRetrieveParams { floating_ip } params, RequestOptionsoptions?): ActionRetrieveResponse { action }

get/v2/floating_ips/{floating_ip}/actions/{action_id}

To retrieve the status of a floating IP action, send a GET request to /v2/floating_ips/$FLOATING_IP/actions/$ACTION_ID.

ParametersExpand Collapse

actionID: number

params: ActionRetrieveParams { floating_ip }

floating_ip: string

A floating IP address.

formatipv4

minimum1

ReturnsExpand Collapse

ActionRetrieveResponse { action }

action?: Action { project_id }

project_id?: string

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

formatuuid

Retrieve an Existing Floating IP Action

typescript

• http
• typescript
• python

import Gradient from '@digitalocean/gradient';

const client = new Gradient();

const action = await client.gpuDroplets.floatingIPs.actions.retrieve(36804636, {
  floating_ip: '45.55.96.47',
});

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"
  }
}