Learn more at Digitalocean.
Quick Start
1. Install
See Install above.
2. Set Up Credentials
Get your access token from your API provider's developer portal, then store it:
digitalocean-pp-cli auth set-token YOUR_TOKEN_HERE
Or set it via environment variable:
export DIGITALOCEAN_BEARER_AUTH="your-token-here"
3. Verify Setup
digitalocean-pp-cli doctor
This checks your configuration and credentials.
4. Try Your First Command
digitalocean-pp-cli 1-clicks list
Unique Features
These capabilities aren't available in any other tool for this API.
Local state that compounds
-
workflow archive — Sync DigitalOcean resources into a local SQLite store for offline inspection and repeatable agent workflows.
Gives agents a durable local inventory before planning cloud changes.
digitalocean-pp-cli workflow archive --full --json
-
search — Search synced DigitalOcean data locally, with live/local source selection for agent-friendly retrieval.
Lets agents locate relevant resources before choosing a narrower command.
digitalocean-pp-cli search "production" --data-source local --json --limit 20
Operational summaries
-
analytics — Summarize locally synced resource data with count and group-by operations.
Turns resource listings into operational summaries an agent can reason about.
digitalocean-pp-cli analytics --type droplets --group-by region --json
-
tail — Poll selected resources and emit change events as NDJSON for shell and agent pipelines.
Provides a safe one-shot or continuous change feed without bespoke scripts.
digitalocean-pp-cli tail --resource droplets --interval 30s --json
Usage
Run digitalocean-pp-cli --help for the full command reference and flag list.
Commands
1-clicks
Manage 1 clicks
digitalocean-pp-cli 1-clicks create - Createdigitalocean-pp-cli 1-clicks list - List
account
Provides information about your current account.
digitalocean-pp-cli account create - Createdigitalocean-pp-cli account delete - Deletedigitalocean-pp-cli account get - Getdigitalocean-pp-cli account list - Listdigitalocean-pp-cli account list-keys - List keysdigitalocean-pp-cli account update - Update
actions
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
-
digitalocean-pp-cli actions get - Get
-
digitalocean-pp-cli actions list - List
add-ons
Add-ons are third-party applications that can be added to your DigitalOcean account.
They are available through the DigitalOcean Marketplace.
Add-ons can be used to enhance the functionality of your existing resources or to provide
additional services.
The Add-Ons API allows you to manage these resources, including creating, listing, and retrieving
details about specific add-on resources.
digitalocean-pp-cli add-ons create - Createdigitalocean-pp-cli add-ons delete - Deletedigitalocean-pp-cli add-ons get - Getdigitalocean-pp-cli add-ons get-addons - Get addonsdigitalocean-pp-cli add-ons list - Listdigitalocean-pp-cli add-ons list-addons - List addonsdigitalocean-pp-cli add-ons update - Updatedigitalocean-pp-cli add-ons update-addons - Update addons
apps
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).
digitalocean-pp-cli apps create - Createdigitalocean-pp-cli apps create-metrics - Create metricsdigitalocean-pp-cli apps create-propose - Create proposedigitalocean-pp-cli apps delete - Deletedigitalocean-pp-cli apps get - Getdigitalocean-pp-cli apps get-tiers - Get tiersdigitalocean-pp-cli apps list - Listdigitalocean-pp-cli apps list-regions - List regionsdigitalocean-pp-cli apps list-tiers - List tiersdigitalocean-pp-cli apps update - Update
async-invoke
Manage async invoke
digitalocean-pp-cli async-invoke create - Create
batches
Manage batches
digitalocean-pp-cli batches create - Createdigitalocean-pp-cli batches create-files - Create filesdigitalocean-pp-cli batches get - Getdigitalocean-pp-cli batches list - List
billing
The billing endpoints allow you to retrieve your account balance, invoices,
billing history, and insights.
Balance: By sending requests to the /v2/customers/my/balance endpoint, you can
retrieve the balance information for the requested customer account.
Invoices: 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.
Billing Insights: Day-over-day changes in billing resource usage based on nightly invoice items,
including total amount, region, SKU, and description for a specified date range.
It is important to note that the daily resource usage may not reflect month-end billing totals when totaled for
a given month as nightly invoice items do not necessarily encompass all invoicing factors for the entire month.
v2/billing/{account_urn}/insights/{start_date}/{end_date} where account_urn is the URN of the customer
account, can be a team (do:team:uuid) or an organization (do:teamgroup:uuid). The date range specified by
start_date and end_date must be in YYYY-MM-DD format.
byoip-prefixes
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
digitalocean-pp-cli byoip-prefixes create - Createdigitalocean-pp-cli byoip-prefixes delete - Deletedigitalocean-pp-cli byoip-prefixes get - Getdigitalocean-pp-cli byoip-prefixes list - Listdigitalocean-pp-cli byoip-prefixes update - Update
cdn
Manage cdn
digitalocean-pp-cli cdn create - Createdigitalocean-pp-cli cdn delete - Deletedigitalocean-pp-cli cdn delete-endpoints - Delete endpointsdigitalocean-pp-cli cdn get - Getdigitalocean-pp-cli cdn list - Listdigitalocean-pp-cli cdn update - Update
certificates
In order to perform SSL termination on load balancers, DigitalOcean offers
two types of SSL certificate management:
-
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.
digitalocean-pp-cli certificates create - Createdigitalocean-pp-cli certificates delete - Deletedigitalocean-pp-cli certificates get - Getdigitalocean-pp-cli certificates list - List
chat
Manage chat
digitalocean-pp-cli chat create - Createdigitalocean-pp-cli chat create-completions - Create completions
customers
Manage customers
digitalocean-pp-cli customers get - Getdigitalocean-pp-cli customers get-my - Get mydigitalocean-pp-cli customers get-my-2 - Get my 2digitalocean-pp-cli customers get-my-3 - Get my 3digitalocean-pp-cli customers list - Listdigitalocean-pp-cli customers list-my - List mydigitalocean-pp-cli customers list-my-2 - List my 2
databases
DigitalOcean's managed database service
simplifies the creation and management of highly available database clusters. Currently, it
offers support for PostgreSQL,
Caching,
Valkey,
MySQL,
MongoDB, and
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.
digitalocean-pp-cli databases create - Createdigitalocean-pp-cli databases delete - Deletedigitalocean-pp-cli databases get - Getdigitalocean-pp-cli databases list - Listdigitalocean-pp-cli databases list-metrics - List metricsdigitalocean-pp-cli databases list-options - List optionsdigitalocean-pp-cli databases update - Update
dedicated-inferences
Dedicated Inference
delivers scalable production-grade LLM hosting on DigitalOcean. Create, list, get, update,
and delete Dedicated Inference instances; manage accelerators, CA certificate, sizes,
GPU model config, and access tokens.
digitalocean-pp-cli dedicated-inferences create - Createdigitalocean-pp-cli dedicated-inferences delete - Deletedigitalocean-pp-cli dedicated-inferences get - Getdigitalocean-pp-cli dedicated-inferences list - Listdigitalocean-pp-cli dedicated-inferences list-dedicatedinferences - List dedicatedinferencesdigitalocean-pp-cli dedicated-inferences list-dedicatedinferences-2 - List dedicatedinferences 2digitalocean-pp-cli dedicated-inferences update - Update
domains
Domain resources are domain names that you have purchased from a domain
name registrar that you are managing through the
DigitalOcean DNS interface.
This resource establishes top-level control over each domain. Actions that
affect individual domain records should be taken on the
Domain Records resource.
digitalocean-pp-cli domains create - Createdigitalocean-pp-cli domains delete - Deletedigitalocean-pp-cli domains get - Getdigitalocean-pp-cli domains list - List
droplets
A Droplet 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.
digitalocean-pp-cli droplets create - Createdigitalocean-pp-cli droplets create-actions - Create actionsdigitalocean-pp-cli droplets create-autoscale - Create autoscaledigitalocean-pp-cli droplets delete - Deletedigitalocean-pp-cli droplets delete-autoscale - Delete autoscaledigitalocean-pp-cli droplets delete-autoscale-2 - Delete autoscale 2digitalocean-pp-cli droplets delete-dropletid - Delete dropletiddigitalocean-pp-cli droplets get - Getdigitalocean-pp-cli droplets get-autoscale - Get autoscaledigitalocean-pp-cli droplets get-autoscale-2 - Get autoscale 2digitalocean-pp-cli droplets get-autoscale-3 - Get autoscale 3digitalocean-pp-cli droplets list - Listdigitalocean-pp-cli droplets list-autoscale - List autoscaledigitalocean-pp-cli droplets list-backups - List backupsdigitalocean-pp-cli droplets list-backups-2 - List backups 2digitalocean-pp-cli droplets update - Update
embeddings
Text embedding vectors via POST /v1/embeddings on the
Serverless Inference base URL
https://inference.do-ai.run (bearer model access key).
digitalocean-pp-cli embeddings create - Create
firewalls
DigitalOcean Cloud 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.
digitalocean-pp-cli firewalls create - Createdigitalocean-pp-cli firewalls delete - Deletedigitalocean-pp-cli firewalls get - Getdigitalocean-pp-cli firewalls list - Listdigitalocean-pp-cli firewalls update - Update
floating-ips
As of 16 June 2022, we have renamed the Floating IP 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,
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
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.
digitalocean-pp-cli floating-ips create - Createdigitalocean-pp-cli floating-ips delete - Deletedigitalocean-pp-cli floating-ips get - Getdigitalocean-pp-cli floating-ips list - List
functions
Serverless 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.
The Serverless Functions API currently only supports creating and managing namespaces.
digitalocean-pp-cli functions create - Createdigitalocean-pp-cli functions create-namespaces - Create namespacesdigitalocean-pp-cli functions create-namespaces-2 - Create namespaces 2digitalocean-pp-cli functions delete - Deletedigitalocean-pp-cli functions delete-namespaces - Delete namespacesdigitalocean-pp-cli functions delete-namespaces-2 - Delete namespaces 2digitalocean-pp-cli functions get - Getdigitalocean-pp-cli functions get-namespaces - Get namespacesdigitalocean-pp-cli functions get-namespaces-2 - Get namespaces 2digitalocean-pp-cli functions get-namespaces-3 - Get namespaces 3digitalocean-pp-cli functions list - Listdigitalocean-pp-cli functions update - Updatedigitalocean-pp-cli functions update-namespaces - Update namespaces
gen-ai
Manage gen ai
digitalocean-pp-cli gen-ai create - Createdigitalocean-pp-cli gen-ai create-genai - Create genaidigitalocean-pp-cli gen-ai create-genai-10 - Create genai 10digitalocean-pp-cli gen-ai create-genai-11 - Create genai 11digitalocean-pp-cli gen-ai create-genai-12 - Create genai 12digitalocean-pp-cli gen-ai create-genai-13 - Create genai 13digitalocean-pp-cli gen-ai create-genai-14 - Create genai 14digitalocean-pp-cli gen-ai create-genai-15 - Create genai 15digitalocean-pp-cli gen-ai create-genai-16 - Create genai 16digitalocean-pp-cli gen-ai create-genai-17 - Create genai 17digitalocean-pp-cli gen-ai create-genai-18 - Create genai 18digitalocean-pp-cli gen-ai create-genai-19 - Create genai 19digitalocean-pp-cli gen-ai create-genai-2 - Create genai 2digitalocean-pp-cli gen-ai create-genai-20 - Create genai 20digitalocean-pp-cli gen-ai create-genai-21 - Create genai 21digitalocean-pp-cli gen-ai create-genai-22 - Create genai 22digitalocean-pp-cli gen-ai create-genai-23 - Create genai 23digitalocean-pp-cli gen-ai create-genai-24 - Create genai 24digitalocean-pp-cli gen-ai create-genai-3 - Create genai 3digitalocean-pp-cli gen-ai create-genai-4 - Create genai 4digitalocean-pp-cli gen-ai create-genai-5 - Create genai 5digitalocean-pp-cli gen-ai create-genai-6 - Create genai 6digitalocean-pp-cli gen-ai create-genai-7 - Create genai 7digitalocean-pp-cli gen-ai create-genai-8 - Create genai 8digitalocean-pp-cli gen-ai create-genai-9 - Create genai 9digitalocean-pp-cli gen-ai delete - Deletedigitalocean-pp-cli gen-ai delete-genai - Delete genaidigitalocean-pp-cli gen-ai delete-genai-10 - Delete genai 10digitalocean-pp-cli gen-ai delete-genai-11 - Delete genai 11digitalocean-pp-cli gen-ai delete-genai-12 - Delete genai 12digitalocean-pp-cli gen-ai delete-genai-13 - Delete genai 13digitalocean-pp-cli gen-ai delete-genai-2 - Delete genai 2digitalocean-pp-cli gen-ai delete-genai-3 - Delete genai 3digitalocean-pp-cli gen-ai delete-genai-4 - Delete genai 4digitalocean-pp-cli gen-ai delete-genai-5 - Delete genai 5digitalocean-pp-cli gen-ai delete-genai-6 - Delete genai 6digitalocean-pp-cli gen-ai delete-genai-7 - Delete genai 7digitalocean-pp-cli gen-ai delete-genai-8 - Delete genai 8digitalocean-pp-cli gen-ai delete-genai-9 - Delete genai 9digitalocean-pp-cli gen-ai get - Getdigitalocean-pp-cli gen-ai get-genai - Get genaidigitalocean-pp-cli gen-ai get-genai-10 - Get genai 10digitalocean-pp-cli gen-ai get-genai-11 - Get genai 11digitalocean-pp-cli gen-ai get-genai-12 - Get genai 12digitalocean-pp-cli gen-ai get-genai-13 - Get genai 13digitalocean-pp-cli gen-ai get-genai-14 - Get genai 14digitalocean-pp-cli gen-ai get-genai-15 - Get genai 15digitalocean-pp-cli gen-ai get-genai-16 - Get genai 16digitalocean-pp-cli gen-ai get-genai-17 - Get genai 17digitalocean-pp-cli gen-ai get-genai-18 - Get genai 18digitalocean-pp-cli gen-ai get-genai-19 - Get genai 19digitalocean-pp-cli gen-ai get-genai-2 - Get genai 2digitalocean-pp-cli gen-ai get-genai-20 - Get genai 20digitalocean-pp-cli gen-ai get-genai-21 - Get genai 21digitalocean-pp-cli gen-ai get-genai-22 - Get genai 22digitalocean-pp-cli gen-ai get-genai-23 - Get genai 23digitalocean-pp-cli gen-ai get-genai-24 - Get genai 24digitalocean-pp-cli gen-ai get-genai-25 - Get genai 25digitalocean-pp-cli gen-ai get-genai-26 - Get genai 26digitalocean-pp-cli gen-ai get-genai-3 - Get genai 3digitalocean-pp-cli gen-ai get-genai-4 - Get genai 4digitalocean-pp-cli gen-ai get-genai-5 - Get genai 5digitalocean-pp-cli gen-ai get-genai-6 - Get genai 6digitalocean-pp-cli gen-ai get-genai-7 - Get genai 7digitalocean-pp-cli gen-ai get-genai-8 - Get genai 8digitalocean-pp-cli gen-ai get-genai-9 - Get genai 9digitalocean-pp-cli gen-ai list - Listdigitalocean-pp-cli gen-ai list-genai - List genaidigitalocean-pp-cli gen-ai list-genai-10 - List genai 10digitalocean-pp-cli gen-ai list-genai-11 - List genai 11digitalocean-pp-cli gen-ai list-genai-12 - List genai 12digitalocean-pp-cli gen-ai list-genai-13 - List genai 13digitalocean-pp-cli gen-ai list-genai-14 - List genai 14digitalocean-pp-cli gen-ai list-genai-15 - List genai 15digitalocean-pp-cli gen-ai list-genai-16 - List genai 16digitalocean-pp-cli gen-ai list-genai-17 - List genai 17digitalocean-pp-cli gen-ai list-genai-2 - List genai 2digitalocean-pp-cli gen-ai list-genai-3 - List genai 3digitalocean-pp-cli gen-ai list-genai-4 - List genai 4digitalocean-pp-cli gen-ai list-genai-5 - List genai 5digitalocean-pp-cli gen-ai list-genai-6 - List genai 6digitalocean-pp-cli gen-ai list-genai-7 - List genai 7digitalocean-pp-cli gen-ai list-genai-8 - List genai 8digitalocean-pp-cli gen-ai list-genai-9 - List genai 9digitalocean-pp-cli gen-ai update - Updatedigitalocean-pp-cli gen-ai update-genai - Update genaidigitalocean-pp-cli gen-ai update-genai-10 - Update genai 10digitalocean-pp-cli gen-ai update-genai-11 - Update genai 11digitalocean-pp-cli gen-ai update-genai-12 - Update genai 12digitalocean-pp-cli gen-ai update-genai-13 - Update genai 13digitalocean-pp-cli gen-ai update-genai-14 - Update genai 14digitalocean-pp-cli gen-ai update-genai-15 - Update genai 15digitalocean-pp-cli gen-ai update-genai-2 - Update genai 2digitalocean-pp-cli gen-ai update-genai-3 - Update genai 3digitalocean-pp-cli gen-ai update-genai-4 - Update genai 4digitalocean-pp-cli gen-ai update-genai-5 - Update genai 5digitalocean-pp-cli gen-ai update-genai-6 - Update genai 6digitalocean-pp-cli gen-ai update-genai-7 - Update genai 7digitalocean-pp-cli gen-ai update-genai-8 - Update genai 8digitalocean-pp-cli gen-ai update-genai-9 - Update genai 9
images
A DigitalOcean image 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 provide
a full copy of an existing Droplet instance taken on demand.
-
Backups are similar
to snapshots but are created automatically at regular intervals when
enabled for a Droplet.
-
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,
are distributions pre-configured with additional software.
To interact with images, you will generally send requests to the images
endpoint at /v2/images.
digitalocean-pp-cli images create - Createdigitalocean-pp-cli images create-generations - Create generationsdigitalocean-pp-cli images delete - Deletedigitalocean-pp-cli images get - Getdigitalocean-pp-cli images list - Listdigitalocean-pp-cli images update - Update
kubernetes
DigitalOcean 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.
digitalocean-pp-cli kubernetes create - Createdigitalocean-pp-cli kubernetes create-clusters - Create clustersdigitalocean-pp-cli kubernetes create-clusters-2 - Create clusters 2digitalocean-pp-cli kubernetes create-clusters-3 - Create clusters 3digitalocean-pp-cli kubernetes create-clusters-4 - Create clusters 4digitalocean-pp-cli kubernetes create-registries - Create registriesdigitalocean-pp-cli kubernetes create-registry - Create registrydigitalocean-pp-cli kubernetes delete - Deletedigitalocean-pp-cli kubernetes delete-clusters - Delete clustersdigitalocean-pp-cli kubernetes delete-clusters-2 - Delete clusters 2digitalocean-pp-cli kubernetes delete-clusters-3 - Delete clusters 3digitalocean-pp-cli kubernetes delete-clusters-4 - Delete clusters 4digitalocean-pp-cli kubernetes delete-clusters-5 - Delete clusters 5digitalocean-pp-cli kubernetes delete-registry - Delete registrydigitalocean-pp-cli kubernetes get - Getdigitalocean-pp-cli kubernetes get-clusters - Get clustersdigitalocean-pp-cli kubernetes get-clusters-2 - Get clusters 2digitalocean-pp-cli kubernetes get-clusters-3 - Get clusters 3digitalocean-pp-cli kubernetes get-clusters-4 - Get clusters 4digitalocean-pp-cli kubernetes get-clusters-5 - Get clusters 5digitalocean-pp-cli kubernetes get-clusters-6 - Get clusters 6digitalocean-pp-cli kubernetes get-clusters-7 - Get clusters 7digitalocean-pp-cli kubernetes get-clusters-8 - Get clusters 8digitalocean-pp-cli kubernetes get-clusters-9 - Get clusters 9digitalocean-pp-cli kubernetes list - Listdigitalocean-pp-cli kubernetes list-options - List optionsdigitalocean-pp-cli kubernetes update - Updatedigitalocean-pp-cli kubernetes update-clusters - Update clusters
load-balancers
DigitalOcean 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.
digitalocean-pp-cli load-balancers create - Createdigitalocean-pp-cli load-balancers delete - Deletedigitalocean-pp-cli load-balancers get - Getdigitalocean-pp-cli load-balancers list - Listdigitalocean-pp-cli load-balancers update - Update
messages
Manage messages
digitalocean-pp-cli messages create - Create
models
Manage models
digitalocean-pp-cli models list - List
monitoring
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.
digitalocean-pp-cli monitoring create - Createdigitalocean-pp-cli monitoring create-sinks - Create sinksdigitalocean-pp-cli monitoring create-sinks-2 - Create sinks 2digitalocean-pp-cli monitoring create-sinks-3 - Create sinks 3digitalocean-pp-cli monitoring delete - Deletedigitalocean-pp-cli monitoring delete-sinks - Delete sinksdigitalocean-pp-cli monitoring delete-sinks-2 - Delete sinks 2digitalocean-pp-cli monitoring get - Getdigitalocean-pp-cli monitoring get-sinks - Get sinksdigitalocean-pp-cli monitoring get-sinks-2 - Get sinks 2digitalocean-pp-cli monitoring list - Listdigitalocean-pp-cli monitoring list-metrics - List metricsdigitalocean-pp-cli monitoring list-metrics-10 - List metrics 10digitalocean-pp-cli monitoring list-metrics-11 - List metrics 11digitalocean-pp-cli monitoring list-metrics-12 - List metrics 12digitalocean-pp-cli monitoring list-metrics-13 - List metrics 13digitalocean-pp-cli monitoring list-metrics-14 - List metrics 14digitalocean-pp-cli monitoring list-metrics-15 - List metrics 15digitalocean-pp-cli monitoring list-metrics-16 - List metrics 16digitalocean-pp-cli monitoring list-metrics-17 - List metrics 17digitalocean-pp-cli monitoring list-metrics-18 - List metrics 18digitalocean-pp-cli monitoring list-metrics-19 - List metrics 19digitalocean-pp-cli monitoring list-metrics-2 - List metrics 2digitalocean-pp-cli monitoring list-metrics-20 - List metrics 20digitalocean-pp-cli monitoring list-metrics-21 - List metrics 21digitalocean-pp-cli monitoring list-metrics-22 - List metrics 22digitalocean-pp-cli monitoring list-metrics-23 - List metrics 23digitalocean-pp-cli monitoring list-metrics-24 - List metrics 24digitalocean-pp-cli monitoring list-metrics-25 - List metrics 25digitalocean-pp-cli monitoring list-metrics-26 - List metrics 26digitalocean-pp-cli monitoring list-metrics-27 - List metrics 27digitalocean-pp-cli monitoring list-metrics-28 - List metrics 28digitalocean-pp-cli monitoring list-metrics-29 - List metrics 29digitalocean-pp-cli monitoring list-metrics-3 - List metrics 3digitalocean-pp-cli monitoring list-metrics-30 - List metrics 30digitalocean-pp-cli monitoring list-metrics-31 - List metrics 31digitalocean-pp-cli monitoring list-metrics-32 - List metrics 32digitalocean-pp-cli monitoring list-metrics-33 - List metrics 33digitalocean-pp-cli monitoring list-metrics-34 - List metrics 34digitalocean-pp-cli monitoring list-metrics-35 - List metrics 35digitalocean-pp-cli monitoring list-metrics-36 - List metrics 36digitalocean-pp-cli monitoring list-metrics-37 - List metrics 37digitalocean-pp-cli monitoring list-metrics-38 - List metrics 38digitalocean-pp-cli monitoring list-metrics-39 - List metrics 39digitalocean-pp-cli monitoring list-metrics-4 - List metrics 4digitalocean-pp-cli monitoring list-metrics-40 - List metrics 40digitalocean-pp-cli monitoring list-metrics-41 - List metrics 41digitalocean-pp-cli monitoring list-metrics-42 - List metrics 42digitalocean-pp-cli monitoring list-metrics-43 - List metrics 43digitalocean-pp-cli monitoring list-metrics-44 - List metrics 44digitalocean-pp-cli monitoring list-metrics-45 - List metrics 45digitalocean-pp-cli monitoring list-metrics-46 - List metrics 46digitalocean-pp-cli monitoring list-metrics-47 - List metrics 47digitalocean-pp-cli monitoring list-metrics-48 - List metrics 48digitalocean-pp-cli monitoring list-metrics-49 - List metrics 49digitalocean-pp-cli monitoring list-metrics-5 - List metrics 5digitalocean-pp-cli monitoring list-metrics-50 - List metrics 50digitalocean-pp-cli monitoring list-metrics-51 - List metrics 51digitalocean-pp-cli monitoring list-metrics-52 - List metrics 52digitalocean-pp-cli monitoring list-metrics-53 - List metrics 53digitalocean-pp-cli monitoring list-metrics-54 - List metrics 54digitalocean-pp-cli monitoring list-metrics-55 - List metrics 55digitalocean-pp-cli monitoring list-metrics-56 - List metrics 56digitalocean-pp-cli monitoring list-metrics-57 - List metrics 57digitalocean-pp-cli monitoring list-metrics-58 - List metrics 58digitalocean-pp-cli monitoring list-metrics-6 - List metrics 6digitalocean-pp-cli monitoring list-metrics-7 - List metrics 7digitalocean-pp-cli monitoring list-metrics-8 - List metrics 8digitalocean-pp-cli monitoring list-metrics-9 - List metrics 9digitalocean-pp-cli monitoring list-sinks - List sinksdigitalocean-pp-cli monitoring list-sinks-2 - List sinks 2digitalocean-pp-cli monitoring update - Update
nfs
NFS lets you create fully managed, POSIX-compliant network file storage that delivers secure,
high-performance shared storage right inside your VPC. This enables seamless data sharing across Droplets in a VPC.
digitalocean-pp-cli nfs create - Createdigitalocean-pp-cli nfs delete - Deletedigitalocean-pp-cli nfs delete-snapshots - Delete snapshotsdigitalocean-pp-cli nfs get - Getdigitalocean-pp-cli nfs get-snapshots - Get snapshotsdigitalocean-pp-cli nfs list - Listdigitalocean-pp-cli nfs list-snapshots - List snapshots
partner-network-connect
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.
digitalocean-pp-cli partner-network-connect create - Createdigitalocean-pp-cli partner-network-connect create-partnernetworkconnect - Create partnernetworkconnectdigitalocean-pp-cli partner-network-connect delete - Deletedigitalocean-pp-cli partner-network-connect get - Getdigitalocean-pp-cli partner-network-connect get-partnernetworkconnect - Get partnernetworkconnectdigitalocean-pp-cli partner-network-connect get-partnernetworkconnect-2 - Get partnernetworkconnect 2digitalocean-pp-cli partner-network-connect get-partnernetworkconnect-3 - Get partnernetworkconnect 3digitalocean-pp-cli partner-network-connect list - Listdigitalocean-pp-cli partner-network-connect update - Update
projects
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.
digitalocean-pp-cli projects create - Createdigitalocean-pp-cli projects create-default - Create defaultdigitalocean-pp-cli projects delete - Deletedigitalocean-pp-cli projects get - Getdigitalocean-pp-cli projects list - Listdigitalocean-pp-cli projects list-default - List defaultdigitalocean-pp-cli projects list-default-2 - List default 2digitalocean-pp-cli projects update - Updatedigitalocean-pp-cli projects update-default - Update defaultdigitalocean-pp-cli projects update-projectid - Update projectiddigitalocean-pp-cli projects update-projectid-2 - Update projectid 2
regions
Provides information about DigitalOcean data center regions.
digitalocean-pp-cli regions list - List
registries
Manage registries
digitalocean-pp-cli registries create - Createdigitalocean-pp-cli registries create-subscription - Create subscriptiondigitalocean-pp-cli registries create-validatename - Create validatenamedigitalocean-pp-cli registries delete - Deletedigitalocean-pp-cli registries get - Getdigitalocean-pp-cli registries list - Listdigitalocean-pp-cli registries list-options - List optionsdigitalocean-pp-cli registries list-subscription - List subscription
registry
Manage registry
digitalocean-pp-cli registry create - Createdigitalocean-pp-cli registry create-subscription - Create subscriptiondigitalocean-pp-cli registry create-validatename - Create validatenamedigitalocean-pp-cli registry delete - Deletedigitalocean-pp-cli registry list - Listdigitalocean-pp-cli registry list-dockercredentials - List dockercredentialsdigitalocean-pp-cli registry list-options - List optionsdigitalocean-pp-cli registry list-subscription - List subscription
reports
Manage reports
digitalocean-pp-cli reports list - List
reserved-ips
As of 16 June 2022, we have renamed the Floating IP
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,
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.
digitalocean-pp-cli reserved-ips create - Createdigitalocean-pp-cli reserved-ips delete - Deletedigitalocean-pp-cli reserved-ips get - Getdigitalocean-pp-cli reserved-ips list - List
reserved-ipv6
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.
digitalocean-pp-cli reserved-ipv6 create - Createdigitalocean-pp-cli reserved-ipv6 delete - Deletedigitalocean-pp-cli reserved-ipv6 get - Getdigitalocean-pp-cli reserved-ipv6 list - List
responses
Manage responses
digitalocean-pp-cli responses create - Create
security
Security CSPM endpoints for scans, scan findings, and settings.
digitalocean-pp-cli security create - Createdigitalocean-pp-cli security create-scans - Create scansdigitalocean-pp-cli security create-settings - Create settingsdigitalocean-pp-cli security delete - Deletedigitalocean-pp-cli security get - Getdigitalocean-pp-cli security get-scans - Get scansdigitalocean-pp-cli security list - Listdigitalocean-pp-cli security list-scans - List scansdigitalocean-pp-cli security list-settings - List settingsdigitalocean-pp-cli security update - Update
sizes
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.
digitalocean-pp-cli sizes list - List
snapshots
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.
digitalocean-pp-cli snapshots delete - Deletedigitalocean-pp-cli snapshots get - Getdigitalocean-pp-cli snapshots list - List
spaces
Manage spaces
digitalocean-pp-cli spaces create - Createdigitalocean-pp-cli spaces delete - Deletedigitalocean-pp-cli spaces get - Getdigitalocean-pp-cli spaces list - Listdigitalocean-pp-cli spaces update - Updatedigitalocean-pp-cli spaces update-keys - Update keys
tags
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.
digitalocean-pp-cli tags create - Createdigitalocean-pp-cli tags delete - Deletedigitalocean-pp-cli tags get - Getdigitalocean-pp-cli tags list - List
upload-url
Manage upload url
digitalocean-pp-cli upload-url update - Update
uptime
DigitalOcean Uptime Checks 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/.
digitalocean-pp-cli uptime create - Createdigitalocean-pp-cli uptime create-checks - Create checksdigitalocean-pp-cli uptime delete - Deletedigitalocean-pp-cli uptime delete-checks - Delete checksdigitalocean-pp-cli uptime get - Getdigitalocean-pp-cli uptime get-checks - Get checksdigitalocean-pp-cli uptime get-checks-2 - Get checks 2digitalocean-pp-cli uptime get-checks-3 - Get checks 3digitalocean-pp-cli uptime list - Listdigitalocean-pp-cli uptime update - Updatedigitalocean-pp-cli uptime update-checks - Update checks
volumes
Manage volumes
digitalocean-pp-cli volumes create - Createdigitalocean-pp-cli volumes create-actions - Create actionsdigitalocean-pp-cli volumes delete - Deletedigitalocean-pp-cli volumes delete-snapshots - Delete snapshotsdigitalocean-pp-cli volumes delete-volumeid - Delete volumeiddigitalocean-pp-cli volumes get - Getdigitalocean-pp-cli volumes get-snapshots - Get snapshotsdigitalocean-pp-cli volumes list - List
vpc-nat-gateways
VPC NAT Gateways
allow resources in a private VPC to access the public internet without
exposing them to incoming traffic.
By sending requests to the /v2/vpc_nat_gateways endpoint, you can create,
configure, list, and delete VPC NAT Gateways as well as retrieve information
about the resources assigned to them.
digitalocean-pp-cli vpc-nat-gateways create - Createdigitalocean-pp-cli vpc-nat-gateways delete - Deletedigitalocean-pp-cli vpc-nat-gateways get - Getdigitalocean-pp-cli vpc-nat-gateways list - Listdigitalocean-pp-cli vpc-nat-gateways update - Update
vpc-peerings
VPC Peerings
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.
digitalocean-pp-cli vpc-peerings create - Createdigitalocean-pp-cli vpc-peerings delete - Deletedigitalocean-pp-cli vpc-peerings get - Getdigitalocean-pp-cli vpc-peerings list - Listdigitalocean-pp-cli vpc-peerings update - Update
vpcs
VPCs (virtual private clouds)
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.
digitalocean-pp-cli vpcs create - Createdigitalocean-pp-cli vpcs delete - Deletedigitalocean-pp-cli vpcs get - Getdigitalocean-pp-cli vpcs list - Listdigitalocean-pp-cli vpcs update - Updatedigitalocean-pp-cli vpcs update-vpcid - Update vpcid
Output Formats
# Human-readable table (default in terminal, JSON when piped)
digitalocean-pp-cli 1-clicks list
# JSON for scripting and agents
digitalocean-pp-cli 1-clicks list --json
# Filter to specific fields
digitalocean-pp-cli 1-clicks list --json --select id,name,status
# Dry run — show the request without sending
digitalocean-pp-cli 1-clicks list --dry-run
# Agent mode — JSON + compact + no prompts in one flag
digitalocean-pp-cli 1-clicks list --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Explicit retries - add
--idempotent to create retries and --ignore-missing to delete retries when a no-op success is acceptable
- Confirmable -
--yes for explicit confirmation of destructive actions
- Piped input - write commands can accept structured input when their help lists
--stdin
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Health Check
digitalocean-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Config file: ~/.config/digitalocean-pp-cli/config.toml
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|
DIGITALOCEAN_BEARER_AUTH | per_call | Yes | Set to your API credential. |
Troubleshooting
Authentication errors (exit code 4)
- Run
digitalocean-pp-cli doctor to check credentials
- Verify the environment variable is set:
echo $DIGITALOCEAN_BEARER_AUTH
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
Generated by CLI Printing Press