Floating IPs
Floating IPs
Create a New Floating IP
Delete a Floating IP
List All Floating IPs
Retrieve an Existing Floating IP
ModelsExpand Collapse
FloatingIP { droplet, ip, locked, 2 more }
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.
Droplet { id, backup_ids, created_at, 20 more }
id: number
A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation.
backup_ids: Array<number>
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.
created_at: string
A time value given in ISO8601 combined date and time format that represents when the Droplet was created.
disk: number
The size of the Droplet's disk in gigabytes.
features: Array<string>
An array of features enabled on this Droplet.
The Droplet's image.
Requires image:read scope.
id?: number
A unique number that can be used to identify and reference a specific image.
created_at?: string
A time value given in ISO8601 combined date and time format that represents when the image was created.
description?: string
An optional free-form text field to describe an image.
distribution?: "Arch Linux" | "CentOS" | "CoreOS" | 10 more
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.
error_message?: string
A string containing information about errors that may occur when importing a custom image.
min_disk_size?: number | null
The minimum disk size in GB required for a Droplet to use this image.
name?: string
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?: boolean
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?: Array<"ams1" | "ams2" | "ams3" | 12 more>
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
size_gigabytes?: number | null
The size of the image in gigabytes.
slug?: string | null
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?: "NEW" | "available" | "pending" | 2 more
A status string indicating the state of a custom image. This may be NEW,
available, pending, deleted, or retired.
tags?: Array<string> | null
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?: "base" | "snapshot" | "backup" | 2 more
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).
locked: boolean
A boolean value indicating whether the Droplet has been locked, preventing actions by users.
memory: number
Memory of the Droplet in megabytes.
name: string
The human-readable name set for the Droplet instance.
networks: Networks { v4, v6 }
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.
gateway?: string
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.
ip_address?: string
The IP address of the IPv4 network interface.
netmask?: string
The netmask of the IPv4 network interface.
type?: "public" | "private"
The type of the IPv4 network interface.
gateway?: string
The gateway of the specified IPv6 network interface.
ip_address?: string
The IP address of the IPv6 network interface.
netmask?: number
The netmask of the IPv6 network interface.
type?: "public"
The type of the IPv6 network interface.
Note: IPv6 private networking is not currently supported.
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?: string
A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window.
start?: string
A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window.
available: boolean
This is a boolean value that represents whether new Droplets can be created in this region.
features: Array<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: Array<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.
available: boolean
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: number
The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes.
memory: number
The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes.
price_hourly: number
This describes the price of the Droplet size as measured hourly. The value is measured in US dollars.
price_monthly: number
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.
regions: Array<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: number
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.
vcpus: number
The number of CPUs allocated to Droplets of this size.
An array of objects containing information about the disks available to Droplets created with this size.
size?: Size { amount, unit }
amount?: number
The amount of space allocated to the disk.
unit?: string
The unit of measure for the disk size.
type?: "local" | "scratch"
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
count?: number
The number of GPUs allocated to the Droplet.
model?: string
The model of the GPU.
vram?: Vram { amount, unit }
amount?: number
The amount of VRAM allocated to the GPU.
unit?: string
The unit of measure for the VRAM.
size_slug: string
The unique slug identifier for the size of this Droplet.
snapshot_ids: Array<number>
An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires image:read scope.
status: "new" | "active" | "off" | "archive"
A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive".
tags: Array<string>
An array of Tags the Droplet has been tagged with.
Requires tag:read scope.
vcpus: number
The number of virtual CPUs.
volume_ids: Array<string>
A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires block_storage:read scope.
An array of objects containing information about the disks available to the Droplet.
size?: Size { amount, unit }
amount?: number
The amount of space allocated to the disk.
unit?: string
The unit of measure for the disk size.
type?: "local" | "scratch"
The type of disk. All Droplets contain a local disk. Additionally, GPU Droplets can also have a scratch disk for non-persistent data.
An object containing information about the GPU capabilities of Droplets created with this size.
count?: number
The number of GPUs allocated to the Droplet.
model?: string
The model of the GPU.
vram?: Vram { amount, unit }
amount?: number
The amount of VRAM allocated to the GPU.
unit?: string
The unit of measure for the VRAM.
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?: number
A unique number used to identify and reference a specific kernel.
name?: string
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?: string
A standard kernel version string representing the version, patch, and release information.
vpc_uuid?: string
A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires vpc:read scope.
ip?: string
The public IP address of the floating IP. It also serves as its identifier.
locked?: boolean
A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.
project_id?: string
The UUID of the project to which the reserved IP currently belongs.
Requires project:read scope.
region?: Region
The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned.