Created
July 9, 2025 19:36
-
-
Save amritk/3e76fb95dd9d16ad5dc96dd4e6be3ca3 to your computer and use it in GitHub Desktop.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| openapi: "3.0.0" | |
| info: | |
| title: DigitalOcean API | |
| version: "2.0" | |
| description: | |
| $ref: "description.yml#/introduction" | |
| license: | |
| name: Apache 2.0 | |
| url: "https://www.apache.org/licenses/LICENSE-2.0.html" | |
| contact: | |
| name: DigitalOcean API Team | |
| email: [email protected] | |
| termsOfService: "https://www.digitalocean.com/legal/terms-of-service-agreement/" | |
| servers: | |
| - url: "https://api.digitalocean.com" | |
| description: production | |
| tags: | |
| - name: 1-Click Applications | |
| description: |- | |
| 1-Click applications are pre-built Droplet images or Kubernetes apps with software, | |
| features, and configuration details already set up for you. They can be found in the | |
| [DigitalOcean Marketplace](https://marketplace.digitalocean.com/). | |
| - name: Account | |
| description: Provides information about your current account. | |
| - name: Actions | |
| description: |- | |
| Actions are records of events that have occurred on the resources in your account. | |
| These can be things like rebooting a Droplet, or transferring an image to a new region. | |
| An action object is created every time one of these actions is initiated. The action | |
| object contains information about the current status of the action, start and complete | |
| timestamps, and the associated resource type and ID. | |
| Every action that creates an action object is available through this endpoint. Completed | |
| actions are not removed from this list and are always available for querying. | |
| **Note:** You can pass the following HTTP header with the request to have the API return | |
| the `reserved_ips` stanza instead of the `floating_ips` stanza: | |
| - `Accept: application/vnd.digitalocean.reserveip+json` | |
| - name: Apps | |
| description: |- | |
| App Platform is a Platform-as-a-Service (PaaS) offering from DigitalOcean that allows | |
| developers to publish code directly to DigitalOcean servers without worrying about the | |
| underlying infrastructure. | |
| Most API operations are centered around a few core object types. Following are the | |
| definitions of these types. These definitions will be omitted from the operation-specific | |
| documentation. | |
| For documentation on app specifications (`AppSpec` objects), please refer to the | |
| [product documentation](https://docs.digitalocean.com/products/app-platform/reference/app-spec/)). | |
| - name: Billing | |
| description: |- | |
| The billing endpoints allow you to retrieve your account balance, invoices | |
| and billing history. | |
| **Balance:** By sending requests to the `/v2/customers/my/balance` endpoint, you can | |
| retrieve the balance information for the requested customer account. | |
| **Invoices:** [Invoices](https://docs.digitalocean.com/platform/billing/invoices/) | |
| are generated on the first of each month for every DigitalOcean | |
| customer. An invoice preview is generated daily, which can be accessed | |
| with the `preview` keyword in place of `$INVOICE_UUID`. To interact with | |
| invoices, you will generally send requests to the invoices endpoint at | |
| `/v2/customers/my/invoices`. | |
| **Billing History:** Billing history is a record of billing events for your account. | |
| For example, entries may include events like payments made, invoices | |
| issued, or credits granted. To interact with invoices, you | |
| will generally send requests to the invoices endpoint at | |
| `/v2/customers/my/billing_history`. | |
| - name: Block Storage | |
| description: |- | |
| [DigitalOcean Block Storage Volumes](https://docs.digitalocean.com/products/volumes/) | |
| provide expanded storage capacity for your Droplets and can be moved | |
| between Droplets within a specific region. | |
| Volumes function as raw block devices, meaning they appear to the | |
| operating system as locally attached storage which can be formatted using | |
| any file system supported by the OS. They may be created in sizes from | |
| 1GiB to 16TiB. | |
| By sending requests to the `/v2/volumes` endpoint, you can list, create, or | |
| delete volumes as well as attach and detach them from Droplets | |
| - name: Block Storage Actions | |
| description: |- | |
| Block storage actions are commands that can be given to a DigitalOcean | |
| Block Storage Volume. An example would be detaching or attaching a volume | |
| from a Droplet. These requests are made on the | |
| `/v2/volumes/$VOLUME_ID/actions` endpoint. | |
| An action object is returned. These objects hold the current status of the | |
| requested action. | |
| - name: CDN Endpoints | |
| description: |- | |
| Content hosted in DigitalOcean's object storage solution, | |
| [Spaces](https://docs.digitalocean.com/products/spaces/), | |
| can optionally be served by our globally distributed Content Delivery | |
| Network (CDN). By sending requests to `/v2/cdn/endpoints`, you can list, | |
| create, or delete CDN Endpoints as well as purge cached content. To use a | |
| custom subdomain to access the CDN Endpoint, provide the ID of a | |
| DigitalOcean managed TLS certificate and the fully qualified domain name | |
| for the custom subdomain. | |
| CDN endpoints have a rate limit of five requests per 10 seconds. | |
| - name: Certificates | |
| description: |- | |
| In order to perform SSL termination on load balancers, DigitalOcean offers | |
| two types of [SSL certificate management](https://docs.digitalocean.com/platform/teams/manage-certificates): | |
| * **Custom**: User-generated certificates may be uploaded to DigitalOcean | |
| where they will be placed in a fully encrypted and isolated storage system. | |
| * **Let's Encrypt**: Certificates may be automatically generated by | |
| DigitalOcean utilizing an integration with Let's Encrypt, the free and | |
| open certificate authority. These certificates will also be automatically | |
| renewed as required. | |
| - name: Container Registry | |
| description: |- | |
| DigitalOcean offers the ability for you to create a | |
| [private container registry](https://docs.digitalocean.com/products/container-registry/) | |
| to store your Docker images for use with your Kubernetes clusters. This | |
| container registry runs inside the same datacenters as your cluster, | |
| ensuring reliable and performant rollout of image deployments. | |
| You can only create one registry per DigitalOcean account, but you can use | |
| that registry to create as many repositories as you wish. | |
| - name: Container Registries | |
| description: |- | |
| DigitalOcean now supports up to nine additional registries (for a total maximum of 10) per team | |
| if your container registry uses the Professional subscription plan. The storage is shared among | |
| the registries. This set of new APIs is backward compatible with `/v2/registry`. However, if you | |
| create more than one registry under a Professional plan, some of the `/v2/registry` APIs would not work. | |
| Hence, it is recommended to use `/v2/registries` for multiple registries. Currently, these APIs are in Public Preview. | |
| - name: Databases | |
| description: |- | |
| DigitalOcean's [managed database service](https://docs.digitalocean.com/products/databases) | |
| simplifies the creation and management of highly available database clusters. Currently, it | |
| offers support for [PostgreSQL](http://docs.digitalocean.com/products/databases/postgresql/), | |
| [Redis](https://docs.digitalocean.com/products/databases/redis/), | |
| [Valkey](https://docs.digitalocean.com/products/databases/valkey/), | |
| [MySQL](https://docs.digitalocean.com/products/databases/mysql/), | |
| [MongoDB](https://docs.digitalocean.com/products/databases/mongodb/), and | |
| [OpenSearch](https://docs.digitalocean.com/products/databases/opensearch/). | |
| By sending requests to the `/v2/databases` endpoint, you can list, create, or delete | |
| database clusters as well as scale the size of a cluster, add or remove read-only replicas, | |
| and manage other configuration details. | |
| Database clusters may be deployed in a multi-node, high-availability configuration. | |
| If your machine type is above the basic nodes, your node plan is above the smallest option, | |
| or you are running MongoDB, you may additionally include up to two standby nodes in your cluster. | |
| The size of individual nodes in a database cluster is represented by a human-readable slug, | |
| which is used in some of the following requests. Each slug denotes the node's identifier, | |
| CPU count, and amount of RAM, in that order. | |
| For a list of currently available database slugs and options, use the `/v2/databases/options` endpoint or use the | |
| `doctl databases options` [command](https://docs.digitalocean.com/reference/doctl/reference/databases/options). | |
| - name: Domain Records | |
| description: |- | |
| Domain record resources are used to set or retrieve information about the | |
| individual DNS records configured for a domain. This allows you to build | |
| and manage DNS zone files by adding and modifying individual records for a | |
| domain. | |
| The [DigitalOcean DNS management interface](https://docs.digitalocean.com/products/networking/dns/) | |
| allows you to configure the following DNS records: | |
| Name | Description | | |
| ------|----------------------------------------------------------------------------------------------------------------------------------------------------| | |
| A | This record type is used to map an IPv4 address to a hostname. | | |
| AAAA | This record type is used to map an IPv6 address to a hostname. | | |
| CAA | As specified in RFC-6844, this record type can be used to restrict which certificate authorities are permitted to issue certificates for a domain. | | |
| CNAME | This record type defines an alias for your canonical hostname (the one defined by an A or AAAA record). | | |
| MX | This record type is used to define the mail exchanges used for the domain. | | |
| NS | This record type defines the name servers that are used for this zone. | | |
| TXT | This record type is used to associate a string of text with a hostname, primarily used for verification. | | |
| SRV | This record type specifies the location (hostname and port number) of servers for specific services. | | |
| SOA | This record type defines administrative information about the zone. Can only have ttl changed, cannot be deleted | | |
| - name: Domains | |
| description: |- | |
| Domain resources are domain names that you have purchased from a domain | |
| name registrar that you are managing through the | |
| [DigitalOcean DNS interface](https://docs.digitalocean.com/products/networking/dns/). | |
| This resource establishes top-level control over each domain. Actions that | |
| affect individual domain records should be taken on the | |
| [Domain Records](#tag/Domain-Records) resource. | |
| - name: Droplet Actions | |
| description: |- | |
| Droplet actions are tasks that can be executed on a Droplet. These can be | |
| things like rebooting, resizing, snapshotting, etc. | |
| Droplet action requests are generally targeted at one of the "actions" | |
| endpoints for a specific Droplet. The specific actions are usually | |
| initiated by sending a POST request with the action and arguments as | |
| parameters. | |
| Droplet action requests create a Droplet actions object, which can be used | |
| to get information about the status of an action. Creating a Droplet | |
| action is asynchronous: the HTTP call will return the action object before | |
| the action has finished processing on the Droplet. The current status of | |
| an action can be retrieved from either the Droplet actions endpoint or the | |
| global actions endpoint. If a Droplet action is uncompleted it may block | |
| the creation of a subsequent action for that Droplet, the locked attribute | |
| of the Droplet will be true and attempts to create a Droplet action will | |
| fail with a status of 422. | |
| - name: Droplets | |
| description: |- | |
| A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean | |
| virtual machine. By sending requests to the Droplet endpoint, you can | |
| list, create, or delete Droplets. | |
| Some of the attributes will have an object value. The `region` and `image` | |
| objects will all contain the standard attributes of their associated | |
| types. Find more information about each of these objects in their | |
| respective sections. | |
| - name: Droplet Autoscale Pools | |
| description: |- | |
| Droplet autoscale pools manage automatic horizontal scaling for your applications based on resource usage (CPU, memory, or both) or a static configuration. | |
| - name: Firewalls | |
| description: |- | |
| [DigitalOcean Cloud Firewalls](https://docs.digitalocean.com/products/networking/firewalls/) | |
| provide the ability to restrict network access to and from a Droplet | |
| allowing you to define which ports will accept inbound or outbound | |
| connections. By sending requests to the `/v2/firewalls` endpoint, you can | |
| list, create, or delete firewalls as well as modify access rules. | |
| - name: Floating IP Actions | |
| description: |- | |
| As of 16 June 2022, we have renamed the Floating IP product to [Reserved IPs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs). | |
| The Reserved IP product's endpoints function the exact same way as Floating IPs. | |
| The only difference is the name change throughout the URLs 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 being | |
| permanently 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 API | |
| where the `floating_ip` field is used. For example, the Droplet metadata response | |
| will contain the field `reserved_ips` in addition to the `floating_ips` field. | |
| Floating IPs retrieved using the Projects API will retain the original name. | |
| Floating IP actions are commands that can be given to a DigitalOcean | |
| floating IP. These requests are made on the actions endpoint of a specific | |
| floating IP. | |
| An action object is returned. These objects hold the current status of the | |
| requested action. | |
| - name: Floating IPs | |
| description: |- | |
| As of 16 June 2022, we have renamed the Floating IP product to [Reserved IPs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs). | |
| The Reserved IP product's endpoints function the exact same way as Floating IPs. | |
| The only difference is the name change throughout the URLs 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 being | |
| permanently 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 API | |
| where the `floating_ip` field is used. For example, the Droplet metadata response | |
| will 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 Floating IPs](https://docs.digitalocean.com/products/networking/reserved-ips/) | |
| are publicly-accessible static IP addresses that can be mapped to one of | |
| your Droplets. They can be used to create highly available setups or other | |
| configurations requiring movable addresses. | |
| Floating IPs are bound to a specific region. | |
| - name: Functions | |
| description: |- | |
| [Serverless functions](https://docs.digitalocean.com/products/functions) are blocks of code that run on demand without the need to manage any infrastructure. | |
| You can develop functions on your local machine and then deploy them to a namespace using `doctl`, the [official DigitalOcean CLI tool](https://docs.digitalocean.com/reference/doctl). | |
| The Serverless Functions API currently only supports creating and managing namespaces. | |
| - name: GradientAI Platform | |
| description: |- | |
| The API lets you build GPU-powered AI agents with pre-built or custom foundation models, function and agent routes, and RAG pipelines with knowledge bases. | |
| - name: Image Actions | |
| description: |- | |
| Image actions are commands that can be given to a DigitalOcean image. In | |
| general, these requests are made on the actions endpoint of a specific | |
| image. | |
| An image action object is returned. These objects hold the current status | |
| of the requested action. | |
| - name: Images | |
| description: |- | |
| A DigitalOcean [image](https://docs.digitalocean.com/products/images/) can be | |
| used to create a Droplet and may come in a number of flavors. Currently, | |
| there are five types of images: snapshots, backups, applications, | |
| distributions, and custom images. | |
| * [Snapshots](https://docs.digitalocean.com/products/snapshots/) provide | |
| a full copy of an existing Droplet instance taken on demand. | |
| * [Backups](https://docs.digitalocean.com/products/backups/) are similar | |
| to snapshots but are created automatically at regular intervals when | |
| enabled for a Droplet. | |
| * [Custom images](https://docs.digitalocean.com/products/custom-images/) | |
| are Linux-based virtual machine images (raw, qcow2, vhdx, vdi, and vmdk | |
| formats are supported) that you may upload for use on DigitalOcean. | |
| * Distributions are the public Linux distributions that are available to | |
| be used as a base to create Droplets. | |
| * Applications, or [1-Click Apps](https://docs.digitalocean.com/products/marketplace/), | |
| are distributions pre-configured with additional software. | |
| To interact with images, you will generally send requests to the images | |
| endpoint at /v2/images. | |
| - name: Kubernetes | |
| description: |- | |
| [DigitalOcean Kubernetes](https://docs.digitalocean.com/products/kubernetes/) | |
| allows you to quickly deploy scalable and secure Kubernetes clusters. By | |
| sending requests to the `/v2/kubernetes/clusters` endpoint, you can list, | |
| create, or delete clusters as well as scale node pools up and down, | |
| recycle individual nodes, and retrieve the kubeconfig file for use with | |
| a cluster. | |
| - name: Load Balancers | |
| description: |- | |
| [DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/) | |
| provide a way to distribute traffic across multiple Droplets. By sending | |
| requests to the `/v2/load_balancers` endpoint, you can list, create, or | |
| delete load balancers as well as add or remove Droplets, forwarding rules, | |
| and other configuration details. | |
| - name: Monitoring | |
| description: |- | |
| The DigitalOcean Monitoring API makes it possible to programmatically retrieve metrics as well as configure alert | |
| policies based on these metrics. The Monitoring API can help you gain insight into how your apps are performing | |
| and consuming resources. | |
| - name: Partner Network Connect | |
| description: |- | |
| Partner Network Connect lets you establish high-bandwidth, low-latency | |
| network connections directly between DigitalOcean VPC networks and other | |
| public cloud providers or on-premises datacenters. | |
| - name: Project Resources | |
| description: |- | |
| Project Resources are resources that can be grouped into your projects. | |
| You can group resources (like Droplets, Spaces, load balancers, domains, | |
| and floating IPs) in ways that align with the applications you host on | |
| DigitalOcean. | |
| ### Supported Resource Types Examples | |
| Projects resources are identified by uniform resource names or URNs. A | |
| valid URN has the following format: `do:resource_type:resource_id`. The | |
| following resource types are supported: | |
| Resource Type | Example URN | |
| -------------------|------------ | |
| App Platform App | `do:app:be5aab85-851b-4cab-b2ed-98d5a63ba4e8` | |
| Database | `do:dbaas:83c7a55f-0d84-4760-9245-aba076ec2fb2` | |
| Domain | `do:domain:example.com` | |
| Droplet | `do:droplet:4126873` | |
| Floating IP | `do:floatingip:192.168.99.100` | |
| Kubernetes Cluster | `do:kubernetes:bd5f5959-5e1e-4205-a714-a914373942af` | |
| Load Balancer | `do:loadbalancer:39052d89-8dd4-4d49-8d5a-3c3b6b365b5b` | |
| Space | `do:space:my-website-assets` | |
| Volume | `do:volume:6fc4c277-ea5c-448a-93cd-dd496cfef71f` | |
| ### Resource Status Codes | |
| When assigning and retrieving resources in projects, a `status` attribute | |
| is returned that indicates if a resource was successfully retrieved or | |
| assigned. The status codes can be one of the following: | |
| Status Code | Explanation | |
| -------------------|------------ | |
| `ok` | There was no problem retrieving or assigning a resource. | |
| `not_found` | The resource was not found. | |
| `assigned` | The resource was successfully assigned. | |
| `already_assigned` | The resource was already assigned. | |
| `service_down` | There was a problem retrieving or assigning a resource. Please try again. | |
| - name: Projects | |
| description: |- | |
| Projects allow you to organize your resources into groups that fit the way | |
| you work. You can group resources (like Droplets, Spaces, load balancers, | |
| domains, and floating IPs) in ways that align with the applications | |
| you host on DigitalOcean. | |
| - name: Regions | |
| description: Provides information about DigitalOcean data center regions. | |
| - name: Reserved IP Actions | |
| description: |- | |
| 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 exact | |
| same way as Floating IPs. The only difference is the name change throughout the | |
| URLs 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 being | |
| permanently 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 API | |
| where the `floating_ip` field is used. For example, the Droplet metadata response | |
| will contain the field `reserved_ips` in addition to the `floating_ips` field. | |
| Floating IPs retrieved using the Projects API will retain the original name. | |
| Reserved IP actions are commands that can be given to a DigitalOcean | |
| reserved IP. These requests are made on the actions endpoint of a specific | |
| reserved IP. | |
| An action object is returned. These objects hold the current status of the | |
| requested action. | |
| - name: Reserved IPs | |
| description: |- | |
| 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 exact | |
| same way as Floating IPs. The only difference is the name change throughout the | |
| URLs 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 being | |
| permanently 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 API | |
| where the `floating_ip` field is used. For example, the Droplet metadata response | |
| will 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 be | |
| mapped to one of your Droplets. They can be used to create highly available | |
| setups or other configurations requiring movable addresses. | |
| Reserved IPs are bound to a specific region. | |
| - name: "[Public Preview] Reserved IPv6" | |
| description: |- | |
| DigitalOcean Reserved IPv6s are publicly-accessible static IP addresses that can be | |
| mapped to one of your Droplets. They can be used to create highly available | |
| setups or other configurations requiring movable addresses. | |
| Reserved IPv6s are bound to a specific region. | |
| - name: "[Public Preview] Reserved IPv6 Actions" | |
| description: |- | |
| Reserved IPv6 actions requests are made on the actions endpoint of a specific | |
| reserved IPv6. | |
| An action object is returned. These objects hold the current status of the | |
| requested action. | |
| - name: "[Public Preview] BYOIP Prefixes" | |
| description: |- | |
| Bring your own IP (BYOIP) lets you provision your own IPv4 network prefixes | |
| to your account, then assign those IPs to your DigitalOcean resources. | |
| BYOIP supports the following features: | |
| * IPv4 addresses | |
| * Network sizes of anywhere from `/24` (256 addresses) to `/18` (16,384 addresses) | |
| * Same API and management interface as our existing reserved IPs feature | |
| * Assignable to Droplets only | |
| BYOIP is currently in Public Preview. | |
| - name: Sizes | |
| description: |- | |
| The sizes objects represent different packages of hardware resources that | |
| can be used for Droplets. When a Droplet is created, a size must be | |
| selected so that the correct resources can be allocated. | |
| Each size represents a plan that bundles together specific sets of | |
| resources. This includes the amount of RAM, the number of virtual CPUs, | |
| disk space, and transfer. The size object also includes the pricing | |
| details and the regions that the size is available in. | |
| - name: Snapshots | |
| description: |- | |
| [Snapshots](https://docs.digitalocean.com/products/snapshots/) are saved | |
| instances of a Droplet or a block storage volume, which is reflected in | |
| the `resource_type` attribute. In order to avoid problems with compressing | |
| filesystems, each defines a `min_disk_size` attribute which is the minimum | |
| size of the Droplet or volume disk when creating a new resource from the | |
| saved snapshot. | |
| To interact with snapshots, you will generally send requests to the | |
| snapshots endpoint at `/v2/snapshots`. | |
| - name: Spaces Keys | |
| description: |- | |
| Spaces keys authenticate requests to DigitalOcean Spaces Buckets. | |
| You can create, list, update, or delete Spaces keys by sending requests to | |
| to the `/v2/spaces/keys` endpoint. | |
| - name: SSH Keys | |
| description: Manage SSH keys available on your account. | |
| - name: Tags | |
| description: |- | |
| A tag is a label that can be applied to a resource (currently Droplets, | |
| Images, Volumes, Volume Snapshots, and Database clusters) in order to | |
| better organize or facilitate the lookups and actions on it. | |
| Tags have two attributes: a user defined `name` attribute and an embedded | |
| `resources` attribute with information about resources that have been tagged. | |
| - name: Uptime | |
| description: >- | |
| [DigitalOcean Uptime Checks](https://docs.digitalocean.com/products/uptime/) provide the ability to monitor your endpoints from around the world, and alert you when they're slow, unavailable, or SSL certificates are expiring. | |
| To interact with Uptime, you will generally send requests to the Uptime endpoint at `/v2/uptime/`. | |
| - name: VPC Peerings | |
| description: |- | |
| [VPC Peerings](https://docs.digitalocean.com/products/networking/vpc/how-to/create-peering/) | |
| join two VPC networks with a secure, private connection. This allows | |
| resources in those networks to connect to each other's private IP addresses | |
| as if they were in the same network. | |
| - name: VPCs | |
| description: |- | |
| [VPCs (virtual private clouds)](https://docs.digitalocean.com/products/networking/vpc/) | |
| allow you to create virtual networks containing resources that can | |
| communicate with each other in full isolation using private IP addresses. | |
| By sending requests to the `/v2/vpcs` endpoint, you can create, configure, | |
| list, and delete custom VPCs as well as retrieve information about the | |
| resources assigned to them. | |
| paths: | |
| /v2/1-clicks: | |
| get: | |
| $ref: "resources/1-clicks/oneClicks_list.yml" | |
| /v2/1-clicks/kubernetes: | |
| post: | |
| $ref: "resources/1-clicks/oneClicks_install_kubernetes.yml" | |
| /v2/account: | |
| get: | |
| $ref: "resources/account/account_get.yml" | |
| components: | |
| securitySchemes: | |
| bearer_auth: | |
| type: http | |
| scheme: bearer | |
| description: | | |
| ## OAuth Authentication | |
| In order to interact with the DigitalOcean API, you or your application must | |
| authenticate. | |
| The DigitalOcean API handles this through OAuth, an open standard for | |
| authorization. OAuth allows you to delegate access to your account. | |
| Scopes can be used to grant full access, read-only access, or access to | |
| a specific set of endpoints. | |
| You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens) | |
| section of the DigitalOcean control panel for your account. | |
| An OAuth token functions as a complete authentication request. In effect, it | |
| acts as a substitute for a username and password pair. | |
| Because of this, it is absolutely **essential** that you keep your OAuth | |
| tokens secure. In fact, upon generation, the web interface will only display | |
| each token a single time in order to prevent the token from being compromised. | |
| DigitalOcean access tokens begin with an identifiable prefix in order to | |
| distinguish them from other similar tokens. | |
| - `dop_v1_` for personal access tokens generated in the control panel | |
| - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/) | |
| - `dor_v1_` for OAuth refresh tokens | |
| ### Scopes | |
| Scopes act like permissions assigned to an API token. These permissions | |
| determine what actions the token can perform. You can create API | |
| tokens that grant read-only access, full access, or limited access to | |
| specific endpoints by using custom scopes. | |
| Generally, scopes are designed to match HTTP verbs and common CRUD | |
| operations (Create, Read, Update, Delete). | |
| | HTTP Verb | CRUD Operation | Scope | | |
| |---|---|---| | |
| | GET | Read | `<resource>:read` | | |
| | POST | Create | `<resource>:create` | | |
| | PUT/PATCH | Update | `<resource>:update` | | |
| | DELETE | Delete | `<resource>:delete` | | |
| For example, creating a new Droplet by making a `POST` request to the | |
| `/v2/droplets` endpoint requires the `droplet:create` scope while | |
| listing Droplets by making a `GET` request to the `/v2/droplets` | |
| endpoint requires the `droplet:read` scope. | |
| Each endpoint below specifies which scope is required to access it when | |
| using custom scopes. | |
| ### How to Authenticate with OAuth | |
| In order to make an authenticated request, include a bearer-type | |
| `Authorization` header containing your OAuth token. All requests must be | |
| made over HTTPS. | |
| ### Authenticate with a Bearer Authorization Header | |
| ``` | |
| curl -X $HTTP_METHOD -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" "https://api.digitalocean.com/v2/$OBJECT" | |
| ``` | |
| security: | |
| - bearer_auth: [] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment