List All Floating IPs

client.GPUDroplets.FloatingIPs.List(ctx, query) (*GPUDropletFloatingIPListResponse, error)

get/v2/floating_ips

To list all of the floating IPs available on your account, send a GET request to /v2/floating_ips.

ParametersExpand Collapse

query GPUDropletFloatingIPListParams

Page param.Field[int64]optional

Which 'page' of paginated results to return.

minimum1

PerPage param.Field[int64]optional

Number of items returned per page

minimum1

maximum200

ReturnsExpand Collapse

type GPUDropletFloatingIPListResponse struct{…}

Meta MetaProperties

Information about the response itself.

Total int64optional

Number of objects returned by the request.

FloatingIPs []FloatingIPoptional

Droplet Dropletoptional

The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Requires droplet:read scope.

Accepts one of the following:

type Droplet struct{…}

ID int64

A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.

BackupIDs []int64

An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
Requires image:read scope.

CreatedAt Time

A time value given in ISO8601 combined date and time format that represents when the Droplet was created.

formatdate-time

Disk int64

The size of the Droplet's disk in gigabytes.

Features []string

An array of features enabled on this Droplet.

Image Image

The Droplet's image.
Requires image:read scope.

ID int64optional

A unique number that can be used to identify and reference a specific image.

CreatedAt Timeoptional

A time value given in ISO8601 combined date and time format that represents when the image was created.

formatdate-time

Description stringoptional

An optional free-form text field to describe an image.

Distribution ImageDistributionoptional

The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE, RancherOS, Rocky Linux, Ubuntu, and Unknown. Any other value will be accepted but ignored, and Unknown will be used in its place.

Accepts one of the following:

const ImageDistributionArchLinux ImageDistribution = "Arch Linux"

const ImageDistributionCentOs ImageDistribution = "CentOS"

const ImageDistributionCoreOs ImageDistribution = "CoreOS"

const ImageDistributionDebian ImageDistribution = "Debian"

const ImageDistributionFedora ImageDistribution = "Fedora"

const ImageDistributionFedoraAtomic ImageDistribution = "Fedora Atomic"

const ImageDistributionFreeBsd ImageDistribution = "FreeBSD"

const ImageDistributionGentoo ImageDistribution = "Gentoo"

const ImageDistributionOpenSuse ImageDistribution = "openSUSE"

const ImageDistributionRancherOs ImageDistribution = "RancherOS"

const ImageDistributionRockyLinux ImageDistribution = "Rocky Linux"

const ImageDistributionUbuntu ImageDistribution = "Ubuntu"

const ImageDistributionUnknown ImageDistribution = "Unknown"

ErrorMessage stringoptional

A string containing information about errors that may occur when importing a custom image.

MinDiskSize int64optional

The minimum disk size in GB required for a Droplet to use this image.

minimum0

Name stringoptional

The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question.

Public booloptional

This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account.

Regions []ImageRegionoptional

This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.

Accepts one of the following:

const ImageRegionAms1 ImageRegion = "ams1"

const ImageRegionAms2 ImageRegion = "ams2"

const ImageRegionAms3 ImageRegion = "ams3"

const ImageRegionBlr1 ImageRegion = "blr1"

const ImageRegionFra1 ImageRegion = "fra1"

const ImageRegionLon1 ImageRegion = "lon1"

const ImageRegionNyc1 ImageRegion = "nyc1"

const ImageRegionNyc2 ImageRegion = "nyc2"

const ImageRegionNyc3 ImageRegion = "nyc3"

const ImageRegionSfo1 ImageRegion = "sfo1"

const ImageRegionSfo2 ImageRegion = "sfo2"

const ImageRegionSfo3 ImageRegion = "sfo3"

const ImageRegionSgp1 ImageRegion = "sgp1"

const ImageRegionTor1 ImageRegion = "tor1"

const ImageRegionSyd1 ImageRegion = "syd1"

SizeGigabytes float64optional

The size of the image in gigabytes.

formatfloat

Slug stringoptional

A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id.

Status ImageStatusoptional

A status string indicating the state of a custom image. This may be NEW, available, pending, deleted, or retired.

Accepts one of the following:

const ImageStatusNew ImageStatus = "NEW"

const ImageStatusAvailable ImageStatus = "available"

const ImageStatusPending ImageStatus = "pending"

const ImageStatusDeleted ImageStatus = "deleted"

const ImageStatusRetired ImageStatus = "retired"

Tags []stringoptional

A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires tag:create scope.

Type ImageTypeoptional

Describes the kind of image. It may be one of base, snapshot, backup, custom, or admin. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes).

Accepts one of the following:

const ImageTypeBase ImageType = "base"

const ImageTypeSnapshot ImageType = "snapshot"

const ImageTypeBackup ImageType = "backup"

const ImageTypeCustom ImageType = "custom"

const ImageTypeAdmin ImageType = "admin"

Locked bool

A boolean value indicating whether the Droplet has been locked, preventing actions by users.

Memory int64

Memory of the Droplet in megabytes.

multipleOf8

Name string

The human-readable name set for the Droplet instance.

Networks DropletNetworks

The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is.

V4 []NetworkV4optional

Gateway stringoptional

The gateway of the specified IPv4 network interface.

For private interfaces, a gateway is not provided. This is denoted by returning nil as its value.

IPAddress stringoptional

The IP address of the IPv4 network interface.

formatipv4

Netmask stringoptional

The netmask of the IPv4 network interface.

formatipv4

Type NetworkV4Typeoptional

The type of the IPv4 network interface.

Accepts one of the following:

const NetworkV4TypePublic NetworkV4Type = "public"

const NetworkV4TypePrivate NetworkV4Type = "private"

V6 []NetworkV6optional

Gateway stringoptional

The gateway of the specified IPv6 network interface.

formatipv6

IPAddress stringoptional

The IP address of the IPv6 network interface.

formatipv6

Netmask int64optional

The netmask of the IPv6 network interface.

Type NetworkV6Typeoptional

The type of the IPv6 network interface.

Note: IPv6 private networking is not currently supported.

Accepts one of the following:

const NetworkV6TypePublic NetworkV6Type = "public"

NextBackupWindow DropletNextBackupWindow

The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start.

End Timeoptional

A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.

formatdate-time

Start Timeoptional

A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.

formatdate-time

Region Region

Available bool

This is a boolean value that represents whether new Droplets can be created in this region.

Features []string

This attribute is set to an array which contains features available in this region

Name string

The display name of the region. This will be a full name that is used in the control panel and other interfaces.

Sizes []string

This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view.

Slug string

A human-readable string that is used as a unique identifier for each region.

Size Size

Available bool

This is a boolean value that represents whether new Droplets can be created with this size.

Description string

A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized.

Disk int64

The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.

Memory int64

The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.

multipleOf8

minimum8

PriceHourly float64

This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.

formatfloat

PriceMonthly float64

This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars.

formatfloat

Regions []string

An array containing the region slugs where this size is available for Droplet creates.

Slug string

A human-readable string that is used to uniquely identify each size.

Transfer float64

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

formatfloat

Vcpus int64

The number of CPUs allocated to Droplets of this size.

DiskInfo []DiskInfooptional

An array of objects containing information about the disks available to Droplets created with this size.

Size DiskInfoSizeoptional

Amount int64optional

The amount of space allocated to the disk.

Unit stringoptional

The unit of measure for the disk size.

Type DiskInfoTypeoptional

The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.

Accepts one of the following:

const DiskInfoTypeLocal DiskInfoType = "local"

const DiskInfoTypeScratch DiskInfoType = "scratch"

GPUInfo GPUInfooptional

An object containing information about the GPU capabilities of Droplets created with this size.

Count int64optional

The number of GPUs allocated to the Droplet.

Model stringoptional

The model of the GPU.

Vram GPUInfoVramoptional

Amount int64optional

The amount of VRAM allocated to the GPU.

Unit stringoptional

The unit of measure for the VRAM.

SizeSlug string

The unique slug identifier for the size of this Droplet.

SnapshotIDs []int64

An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires image:read scope.

Status DropletStatus

A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".

Accepts one of the following:

const DropletStatusNew DropletStatus = "new"

const DropletStatusActive DropletStatus = "active"

const DropletStatusOff DropletStatus = "off"

const DropletStatusArchive DropletStatus = "archive"

Tags []string

An array of Tags the Droplet has been tagged with.
Requires tag:read scope.

Vcpus int64

The number of virtual CPUs.

VolumeIDs []string

A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires block_storage:read scope.

DiskInfo []DiskInfooptional

An array of objects containing information about the disks available to the Droplet.

Size DiskInfoSizeoptional

Amount int64optional

The amount of space allocated to the disk.

Unit stringoptional

The unit of measure for the disk size.

Type DiskInfoTypeoptional

The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.

Accepts one of the following:

const DiskInfoTypeLocal DiskInfoType = "local"

const DiskInfoTypeScratch DiskInfoType = "scratch"

GPUInfo GPUInfooptional

An object containing information about the GPU capabilities of Droplets created with this size.

Count int64optional

The number of GPUs allocated to the Droplet.

Model stringoptional

The model of the GPU.

Vram GPUInfoVramoptional

Amount int64optional

The amount of VRAM allocated to the GPU.

Unit stringoptional

The unit of measure for the VRAM.

DeprecatedKernel Kerneloptional

Note: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to null.

The current kernel for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created.

ID int64optional

A unique number used to identify and reference a specific kernel.

Name stringoptional

The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question.

Version stringoptional

A standard kernel version string representing the version, patch, and release information.

VpcUuid stringoptional

A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires vpc:read scope.

IP stringoptional

The public IP address of the floating IP. It also serves as its identifier.

formatipv4

Locked booloptional

A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.

ProjectID stringoptional

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

Requires project:read scope.

formatuuid

Region FloatingIPRegionoptional

The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned.

Links PageLinksoptional

Pages PageLinksPagesoptional

Accepts one of the following:

type ForwardLinks struct{…}

Last stringoptional

URI of the last page of the results.

Next stringoptional

URI of the next page of the results.

type BackwardLinks struct{…}

First stringoptional

URI of the first page of the results.

Prev stringoptional

URI of the previous page of the results.

List All Floating IPs

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := gradient.NewClient(
    option.WithAccessToken("My Access Token"),
  )
  floatingIPs, err := client.GPUDroplets.FloatingIPs.List(context.TODO(), gradient.GPUDropletFloatingIPListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", floatingIPs.Meta)
}

{
  "meta": {
    "total": 1
  },
  "floating_ips": [
    {
      "droplet": null,
      "ip": "45.55.96.47",
      "locked": false,
      "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "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-192g"
        ],
        "slug": "nyc3"
      }
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}

Returns Examples

{
  "meta": {
    "total": 1
  },
  "floating_ips": [
    {
      "droplet": null,
      "ip": "45.55.96.47",
      "locked": false,
      "project_id": "746c6152-2fa2-11ed-92d3-27aaa54e4988",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "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-192g"
        ],
        "slug": "nyc3"
      }
    }
  ],
  "links": {
    "pages": {
      "last": "https://api.digitalocean.com/v2/images?page=2",
      "next": "https://api.digitalocean.com/v2/images?page=2"
    }
  }
}