How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Digital Ocean Reserved IPs API

As of 16 June 2022, we have renamed the [Floating IP](https://docs.digitalocean.com/reference/api/api-reference/#tag/Floating-IPs)product to Reserved IPs. The Reserved IP product's endpoints function the exactsame way as Floating IPs. The only difference is the name change throughout theURLs and fields. For example, the `floating_ips` field is now the `reserved_ips` field.The Floating IP endpoints will remain active until fall 2023 before beingpermanently deprecated.With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),we will reflect this change as an additional field in the responses across the APIwhere the `floating_ip` field is used. For example, the Droplet metadata responsewill contain the field `reserved_ips` in addition to the `floating_ips` field.Floating IPs retrieved using the Projects API will retain the original name.DigitalOcean Reserved IPs are publicly-accessible static IP addresses that can bemapped to one of your Droplets. They can be used to create highly availablesetups or other configurations requiring movable addresses.Reserved IPs are bound to a specific region.

Digital Ocean Reserved IPs API is one of 37 APIs that Digital Ocean publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reserved IPs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 30 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.digitalocean.com.

4 operations 2 paths 30 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.digitalocean.com/v2
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Digital Ocean Reserved IPs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer_auth). By default, every request must be authenticated.

  • bearer_auth — OAuth Authentication In order to interact with the DigitalOcean API, you or your application must authenticate. The DigitalOcean API handles this through OAuth…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reserved IPs 4

As of 16 June 2022, we have renamed the [Floating IP](https://docs.digitalocean.com/reference/api/api-reference/tag/Floating-IPs) product to Reserved IPs. The Reserved IP product'…

GET
/v2/reserved_ips
List All Reserved IPs
reservedIPs_list 2 params → 200401429500default
POST
/v2/reserved_ips
Create a New Reserved IP
reservedIPs_create body → 202401429500default
GET
/v2/reserved_ips/{reserved_ip}
Retrieve an Existing Reserved IP
reservedIPs_get 1 param → 200401404429500default
DELETE
/v2/reserved_ips/{reserved_ip}
Delete a Reserved IP
reservedIPs_delete 1 param → 204401404429500default

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are droplet (23 properties), image (14 properties), size (12 properties), reserved_ip (5 properties). Each schema is shown below with its type and property counts.

size
object
12 properties 10 required
distribution
string
The name of a custom image's distribution. Currently, the valid values are Arch Linux, CentOS, CoreOS, Debian, Fedora, Fedora Atomic, FreeBSD, Gentoo, openSUSE…
regions_array
array
This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values.
network_v6
object
4 properties
link_to_prev_page
object
1 property
link_to_last_page
object
1 property
page_links
object
1 property
gpu_info
object
An object containing information about the GPU capabilities of Droplets created with this size.
3 properties
region_slug
string
The slug identifier for the region where the resource will initially be available.
reserved_ip
object
5 properties
forward_links
image_description
string
An optional free-form text field to describe an image.
region
object
5 properties 5 required
pagination
object
1 property
link_to_first_page
object
1 property
error
object
3 properties 2 required
backward_links
disk_info
object
2 properties
action_link
object
The linked actions can be used to check the status of a Droplet's create event.
3 properties
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.
meta_properties
object
Information about the response itself.
1 property
kernel
object
Note: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to null. The current [kernel](https://…
3 properties
meta
object
1 property 1 required
droplet_next_backup_window
object
2 properties
droplet
object
23 properties 19 required
image
object
14 properties
link_to_next_page
object
1 property
reserved_ip_create
tags_array
array
A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.
network_v4
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

digital-ocean-reserved-ips-api-openapi.yml Raw ↑

Other APIs Digital Ocean publishes across the network.

Digital Ocean 1-Click Applications API
Digital Ocean Account API
Digital Ocean Actions API
Digital Ocean Apps API
Digital Ocean Billing API
Digital Ocean Block Storage Actions API
Digital Ocean Block Storage API
Digital Ocean CDN Endpoints API
Digital Ocean Certificates API
Digital Ocean Container Registry API
Digital Ocean Databases API
Digital Ocean Domain Records API
Where this information came from

This is an independent, third-party profile of Digital Ocean Reserved IPs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.