DigitalOcean
Overview
Section titled “Overview”DigitalOcean is a cloud infrastructure provider offering scalable compute platforms with a user-friendly interface. With the DigitalOcean integration in SquadOS, your agents can provision and manage your entire cloud infrastructure — creating droplets, database clusters, load balancers, firewalls, DNS domains, storage volumes, and private networks (VPCs) — directly from conversations.
- Official website: https://www.digitalocean.com/
- Composio documentation: docs.composio.dev/toolkits/digital_ocean
Authentication
Section titled “Authentication”This tool uses API key (API_KEY) or OAuth 2.0 (OAUTH2) to connect.
You will need the following fields (for API key connection):
| Field | Required | Description |
|---|---|---|
api_key | Yes | Personal access token generated in the DigitalOcean dashboard under API → Tokens. |
How to get credentials
Section titled “How to get credentials”- Go to cloud.digitalocean.com and log in to your account.
- In the left menu, click API.
- Under the Tokens tab, click Generate New Token.
- Give the token a name (e.g.,
squados-agent), choose Read & Write scope, and click Generate Token. - Copy the displayed token — it will not be shown again.
How to connect in SquadOS
Section titled “How to connect in SquadOS”- Go to Tools in the side menu (
/admin/tools). - Open the Available tab and search for
DigitalOcean. - Click the card to open the details modal and hit Connect.
- You’re taken to the secure connection page hosted by Composio, where you enter the API key obtained above (or authorize via OAuth 2.0).
- Once done, you’re sent back to SquadOS with the account connected and the tool available for your agents. (Connection-flow details in Organization Tools.)
Available actions
Section titled “Available actions”Create Custom Image
Section titled “Create Custom Image”DIGITAL_OCEAN_CREATE_CUSTOM_IMAGE
Creates a custom image in DigitalOcean by importing a Linux VM disk image from a publicly accessible URL. Use this action to upload custom OS images (Ubuntu, Debian, CentOS, Fedora, etc.) that can later be used to create Droplets. The image will be processed asynchronously and its status can be monitored via the returned image ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Publicly accessible URL (HTTP/HTTPS) pointing to a Linux VM disk image. Supported formats: Raw (.img), qcow2, VHDX, VDI, VMDK. May be compressed with gzip or bzip2. |
name | string | Yes | A human-readable name for the custom image (e.g., ‘ubuntu-20.04-webserver’). |
tags | array | No | Optional list of tag strings for organizing and categorizing the image. |
region | string | Yes | DigitalOcean region slug where the image will be initially stored (e.g., ‘nyc1’, ‘nyc3’, ‘sfo2’, ‘sfo3’, ‘lon1’, ‘ams3’). |
description | string | No | Optional detailed description of the image’s purpose, contents, or configuration. |
distribution | string | Yes | Operating system distribution name. Valid options: ‘Ubuntu’, ‘Debian’, ‘CentOS’, ‘Fedora’, ‘Arch Linux’, or ‘Unknown’. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Database Cluster
Section titled “Create Database Cluster”DIGITAL_OCEAN_CREATE_DATABASE_CLUSTER
Creates a new managed database cluster on DigitalOcean. Provisions a database with specified engine (PostgreSQL, MySQL, Valkey, MongoDB, Kafka, or OpenSearch), version, region, size, and node count. Returns connection credentials and cluster details. The cluster will be in ‘creating’ status initially and take several minutes to become fully operational.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for your database cluster. |
size | string | Yes | Size slug for the database nodes. Examples: db-s-1vcpu-1gb, db-s-2vcpu-4gb, gd-2vcpu-8gb. |
tags | array | No | Tags to assign to the cluster. |
engine | string (“pg” | “mysql” | “valkey” | “mongodb” | “kafka” | “opensearch”) | Yes | Database engine type: ‘pg’ (PostgreSQL), ‘mysql’ (MySQL), ‘valkey’ (Redis-compatible), ‘mongodb’ (MongoDB), ‘kafka’ (Apache Kafka), ‘opensearch’ (OpenSearch). |
region | string | Yes | Region slug where the cluster will be created. Examples: nyc1, nyc3, sfo3, lon1, fra1, ams3, sgp1, tor1, blr1. |
version | string | Yes | Database engine version. Examples: ‘16’ for PostgreSQL, ‘8’ for MySQL/Valkey, ‘8.0’ for MongoDB, ‘3.8’ for Kafka, ‘2’ for OpenSearch. |
db_names | array | No | Names of databases to create in the cluster. |
sql_mode | string | No | SQL mode for MySQL clusters. |
num_nodes | integer | Yes | Number of nodes in the cluster. Typical values: 1 (single node), 2 (primary + standby), 3 (high availability). |
user_names | array | No | Usernames to create in the cluster. |
backup_restore | object | No | Configuration to restore a cluster from a backup. |
eviction_policy | string | No | Eviction policy for Redis clusters. |
storage_size_gb | integer | No | Additional storage size in GiB for the cluster. |
maintenance_window | object | No | Maintenance window configuration for the cluster. |
private_network_uuid | string | No | UUID of VPC network for private networking. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Block Storage Volume
Section titled “Create New Block Storage Volume”DIGITAL_OCEAN_CREATE_NEW_BLOCK_STORAGE_VOLUME
Tool to create a new block storage volume. Use when you need to provision persistent block storage after confirming the target region supports volumes. Example: “Create a 100 GiB ext4 backup volume named ‘db-backup’ in nyc1.”
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A human-readable name for the block storage volume. |
tags | array | No | List of tags to apply to the volume. |
region | string | Yes | Slug identifier for the region where the volume will be created (e.g., ‘nyc1’). |
description | string | No | Free-form text description of the volume. |
snapshot_id | string | No | Unique identifier of a snapshot to create the volume from. |
size_gigabytes | integer | Yes | Size of the block storage volume in GiB (minimum 1). |
filesystem_type | string | No | Filesystem type to initialize on the volume (e.g., ‘ext4’). |
filesystem_label | string | No | Label to apply to the filesystem. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Domain
Section titled “Create New Domain”DIGITAL_OCEAN_CREATE_NEW_DOMAIN
Creates a new domain in DigitalOcean’s DNS management system. This adds the domain to your DigitalOcean account and allows you to manage its DNS records. Use this action when you need to add a domain to DigitalOcean DNS for DNS hosting and management, set up a new domain with an optional initial A record pointing to an IP address, or transfer DNS management of an existing domain to DigitalOcean.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The domain name to add to DigitalOcean DNS management (e.g., ‘example.com’). Must be a valid domain with a recognized TLD. The domain must be unique and not already exist in the account. |
ip_address | string | No | Optional IPv4 address to create an initial A record pointing the domain apex to this IP. If not provided, the domain will be created without any DNS records. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create Domain Record
Section titled “Create Domain Record”DIGITAL_OCEAN_CREATE_NEW_DOMAIN_RECORD
Tool to create a new DNS record for a domain. Use after confirming domain exists and record specifics.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | No | Tag for CAA records (issue, issuewild, iodef); required if type is CAA. |
ttl | integer | No | Time to live for the record in seconds. |
data | string | Yes | Value of the DNS record. Format depends on the record type. For CAA records with issue/issuewild tags, use FQDN with trailing dot (e.g., ‘letsencrypt.org.’). |
name | string | No | Host name for the record (e.g., ‘www’). Use ’@’ for root domain. |
port | integer | No | Port for SRV records; required if type is SRV. |
type | string (“A” | “AAAA” | “CNAME” | “MX” | “TXT” | “NS” | “SRV” | “CAA”) | Yes | Type of DNS record to create. |
flags | integer | No | Flags for CAA records; required if type is CAA. |
weight | integer | No | Weight for SRV records; required if type is SRV. |
priority | integer | No | Priority for MX and SRV records; required if type is MX or SRV. |
domain_name | string | Yes | The domain name to add the record to, e.g., ‘example.com’. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Droplet
Section titled “Create New Droplet”DIGITAL_OCEAN_CREATE_NEW_DROPLET
Tool to create a new Droplet. Use when you need to provision a VM with name, region, size, and image. The image, region, and size must be mutually compatible — the chosen region must be listed in the image’s available regions.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
ipv6 | boolean | No | Whether IPv6 is enabled. |
name | string | Yes | A human-readable name for the Droplet. |
size | string | Yes | Size slug for the Droplet. |
tags | array | No | List of tags to apply to the Droplet. |
image | string | Yes | Image slug or ID to use for the Droplet. |
region | string | Yes | Region slug where the Droplet will be created. |
backups | boolean | No | Whether automatic backups are enabled. |
volumes | array | No | IDs of volumes to attach to the Droplet. |
ssh_keys | array | No | List of SSH key IDs or fingerprints to embed. |
vpc_uuid | string | No | VPC UUID to assign the Droplet to. |
user_data | string | No | User data (cloud-init) script to configure the Droplet. |
monitoring | boolean | No | Whether monitoring is enabled. |
private_networking | boolean | No | Deprecated: use ‘vpc_uuid’ instead. |
with_droplet_agent | boolean | No | Whether to install the Droplet agent for metrics. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Firewall
Section titled “Create New Firewall”DIGITAL_OCEAN_CREATE_NEW_FIREWALL
Creates a new cloud firewall with custom inbound and outbound rules. Use this action to set up network security rules that control traffic to and from your Droplets. You can specify rules using IP addresses (CIDR notation), Droplet IDs, tags, Load Balancer UUIDs, or Kubernetes cluster IDs. Requires at least one inbound rule and one outbound rule. Supports tcp, udp, and icmp protocols.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name of the new firewall. |
tags | array | No | Optional list of Droplet tags to apply the firewall to matching droplets. |
vpc_uuid | string | No | Optional VPC UUID to scope this firewall to a VPC. |
droplet_ids | array | No | Optional list of Droplet IDs to apply the firewall to. |
inbound_rules | array | Yes | List of inbound rules; must contain at least one. |
outbound_rules | array | Yes | List of outbound rules; must contain at least one. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Kubernetes Cluster
Section titled “Create New Kubernetes Cluster”DIGITAL_OCEAN_CREATE_NEW_KUBERNETES_CLUSTER
Creates a new DigitalOcean Kubernetes (DOKS) cluster with managed control plane. Required: cluster name, region slug, Kubernetes version slug, and at least one node pool configuration. Optional: tags, auto-upgrade settings, maintenance policy, node labels/taints, and auto-scaling. The cluster will be created in ‘provisioning’ state and may take several minutes to become ‘running’.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A human-readable name for the Kubernetes cluster. |
tags | array | No | List of tags to apply to the cluster. |
region | string | Yes | Region slug where the cluster will be created. Common regions: nyc1, nyc3, sfo3, lon1, fra1, tor1, blr1, sgp1, ams3, syd1. |
version | string | Yes | Kubernetes version slug to deploy (e.g., ‘1.34.1-do.3’, ‘1.33.6-do.3’). Use /v2/kubernetes/options to get current available versions. |
node_pools | array | Yes | List of node pools; at least one required. |
auto_upgrade | boolean | No | Whether to auto-upgrade to new patch releases. |
maintenance_policy | object | No | Scheduled maintenance policy for the cluster. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Load Balancer
Section titled “Create New Load Balancer”DIGITAL_OCEAN_CREATE_NEW_LOAD_BALANCER
Tool to create a new load balancer. Use after specifying region, forwarding rules, and targets.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | No | Tag to select droplets (mutually exclusive with droplet_ids). |
name | string | Yes | Unique name for the new load balancer. |
region | string | Yes | Region slug where the load balancer will be created (e.g., ‘nyc1’). |
vpc_uuid | string | No | UUID of the VPC to assign the load balancer to. |
algorithm | string (“round_robin” | “least_connections”) | No | Load balancing algorithm to use; defaults to ‘round_robin’. |
droplet_ids | array | No | List of droplet IDs to attach (mutually exclusive with tag). |
health_check | object | No | Optional health check configuration. |
firewall_policy | string | No | ID of a custom firewall policy to apply. |
sticky_sessions | object | No | Optional session persistence configuration. |
forwarding_rules | array | Yes | List of forwarding rules mapping entry to target protocols and ports. |
enable_proxy_protocol | boolean | No | Enable PROXY protocol for backend connections. |
redirect_http_to_https | boolean | No | Redirect HTTP traffic to HTTPS. |
enable_backend_keepalive | boolean | No | Enable keepalive connections to backend droplets. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New SSH Key
Section titled “Create New SSH Key”DIGITAL_OCEAN_CREATE_NEW_SSH_KEY
Registers a new SSH public key with your DigitalOcean account. The registered key can then be automatically added to new Droplets during creation, enabling secure SSH access. The key must be provided in OpenSSH format (ssh-rsa, ssh-ed25519, etc.) and must not already exist on the account.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A human-readable name to identify the SSH key (e.g., ‘laptop-key’, ‘production-server’). |
public_key | string | Yes | The complete SSH public key string in OpenSSH format. Must start with the key type (ssh-rsa, ssh-ed25519, ecdsa-sha2-nistp256, etc.) followed by the base64-encoded key data and an optional comment. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New Tag
Section titled “Create New Tag”DIGITAL_OCEAN_CREATE_NEW_TAG
Creates a new tag in DigitalOcean for organizing and grouping resources. Tags can be applied to droplets, images, volumes, volume snapshots, and databases. If a tag with the same name already exists, the API returns the existing tag (idempotent operation). Tag names must be 1-255 characters containing only letters, numbers, hyphens, or underscores.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the new tag. Must be 1-255 characters and only contain alphanumeric characters, hyphens (-), or underscores (_). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Create New VPC
Section titled “Create New VPC”DIGITAL_OCEAN_CREATE_NEW_VPC
Creates a new Virtual Private Cloud (VPC) in a specified DigitalOcean region. VPCs are private networks for isolating your resources. Traffic within a VPC is free and doesn’t count toward bandwidth limits. The first VPC created in a region automatically becomes the default VPC for that region.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the VPC. Must be unique within your account. |
tags | array | No | List of tag names to apply to the VPC after creation. |
region | string | Yes | Slug identifier for the region where the VPC will be created. Common regions include nyc3 (New York), sfo3 (San Francisco), lon1 (London), fra1 (Frankfurt), sgp1 (Singapore), tor1 (Toronto). |
ip_range | string | No | The IP range in CIDR notation for the VPC. Network size must be between /16 and /28. If not specified, DigitalOcean assigns a default range automatically. Must not overlap with any existing VPC IP ranges in your account. |
description | string | No | A free-form description of the VPC. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Block Storage Volume
Section titled “Delete Block Storage Volume”DIGITAL_OCEAN_DELETE_BLOCK_STORAGE_VOLUME
Permanently deletes a block storage volume by its unique ID. Use this tool when you need to remove an existing volume. The volume must not be attached to any Droplet before deletion. This operation cannot be undone. Returns HTTP 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
volume_id | string | Yes | The unique identifier (UUID) of the block storage volume to delete. The volume must not be attached to any Droplet. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Database Cluster
Section titled “Delete Database Cluster”DIGITAL_OCEAN_DELETE_DATABASE_CLUSTER
Tool to delete a database cluster by UUID. Use when you have confirmed the cluster is no longer needed. Returns HTTP 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
database_cluster_uuid | string | Yes | The UUID of the database cluster to destroy. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Domain
Section titled “Delete Domain”DIGITAL_OCEAN_DELETE_DOMAIN
Deletes a domain from DigitalOcean DNS. This action is permanent and cannot be undone. Note: If the domain is associated with a Let’s Encrypt certificate, delete the certificate first and reconfigure any resources using it. Returns 204 No Content on successful deletion.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The fully qualified domain name to delete, e.g., ‘example.com’. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Domain Record
Section titled “Delete Domain Record”DIGITAL_OCEAN_DELETE_DOMAIN_RECORD
Tool to delete a DNS record by its record ID for a domain. Use when you need to remove an existing DNS record and have the domain name and record ID. Returns HTTP 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The domain name (e.g., ‘example.com’). |
record_id | integer | Yes | The unique identifier of the DNS record to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Existing Droplet
Section titled “Delete Existing Droplet”DIGITAL_OCEAN_DELETE_EXISTING_DROPLET
Tool to delete a Droplet by ID. Deletion is irreversible — all data is permanently lost. Confirm droplet_id with the user and verify a backup or snapshot exists before proceeding.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
droplet_id | integer | Yes | Unique identifier of the Droplet to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Firewall
Section titled “Delete Firewall”DIGITAL_OCEAN_DELETE_FIREWALL
Tool to delete a firewall by ID. Use when you have confirmed the firewall is no longer needed.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
firewall_id | string | Yes | Unique identifier of the firewall to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Image
Section titled “Delete Image”DIGITAL_OCEAN_DELETE_IMAGE
Deletes a user-created custom image or snapshot from your DigitalOcean account by its numeric ID. This action permanently removes the image and cannot be undone. Only custom images and snapshots you own can be deleted — attempting to delete distribution images or marketplace applications will fail with a 403 Forbidden error.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
image_id | integer | Yes | The unique numeric ID of the custom image or snapshot to delete. Note: Only user-created custom images and snapshots can be deleted. DigitalOcean distribution images and marketplace application images cannot be deleted and will return a 403 Forbidden error. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Load Balancer
Section titled “Delete Load Balancer”DIGITAL_OCEAN_DELETE_LOAD_BALANCER
Tool to delete a load balancer instance by ID. Use when you need to permanently remove an existing load balancer after confirming its ID. Returns 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
load_balancer_id | string | Yes | Unique identifier of the load balancer to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete SSH Key
Section titled “Delete SSH Key”DIGITAL_OCEAN_DELETE_SSH_KEY
Tool to delete a public SSH key. Use when you need to remove an SSH key from your account by its ID or fingerprint after confirming its ownership. Returns 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
key_id_or_fingerprint | string | Yes | The identifier for the SSH key (numeric ID or fingerprint). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete Tag
Section titled “Delete Tag”DIGITAL_OCEAN_DELETE_TAG
Deletes a tag from your DigitalOcean account. When a tag is deleted, it is automatically removed from all resources that were tagged with it. This operation is idempotent — deleting a non-existent tag will also return success (204 No Content).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the tag to delete; all resources with this tag will be untagged. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Delete VPC
Section titled “Delete VPC”DIGITAL_OCEAN_DELETE_VPC
Delete a VPC (Virtual Private Cloud) by its unique identifier. Use this tool when you need to permanently remove a VPC from your DigitalOcean account. Deletion is irreversible. Important restrictions: cannot delete a VPC that is the default VPC for its region, nor one that has member resources (droplets, databases, load balancers, etc.) — all resources must be detached or migrated first.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
vpc_id | string | Yes | Unique identifier of the VPC to delete. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Databases
Section titled “List All Databases”DIGITAL_OCEAN_LIST_ALL_DATABASES
Tool to list all managed database clusters on your account. Supports pagination and filtering by tag. A single request returns only one page; iterate using page and per_page to retrieve all clusters.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). |
per_page | integer | No | Number of items to return per page. Must be between 1 and 200. |
tag_name | string | No | Filter to return only database clusters with this tag name. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Domains
Section titled “List All Domains”DIGITAL_OCEAN_LIST_ALL_DOMAINS
Lists all DNS domains configured in your DigitalOcean account. Returns domain names, TTL values, and complete zone files. Supports pagination for large domain lists. No parameters are required — calling without parameters returns the first 20 domains (default page size).
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). |
per_page | integer | No | Number of domains to return per page (1-200). Default is 20 if omitted. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Droplets
Section titled “List All Droplets”DIGITAL_OCEAN_LIST_ALL_DROPLETS
Lists all Droplets (virtual machines) in your DigitalOcean account with pagination support. Returns detailed information including: ID, name, specs (memory, vCPUs, disk), status, networking (IP addresses), region, image, size, tags, and VPC. Supports filtering by tag and pagination for large result sets. Default page size is 20; accounts with more droplets require explicit pagination (increment page, up to per_page=200) to avoid silently incomplete results.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page of results to return. Must be >= 1. Default is 1. |
per_page | integer | No | Number of items per page. Must be between 1 and 200. Default is 20. |
tag_name | string | No | Filter droplets by tag name. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Firewalls
Section titled “List All Firewalls”DIGITAL_OCEAN_LIST_ALL_FIREWALLS
List all cloud firewalls configured in your DigitalOcean account. Returns comprehensive firewall details including inbound/outbound rules, associated droplets, tags, and status. Supports pagination for accounts with many firewalls.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). |
per_page | integer | No | Number of firewalls to return per page (1-200). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Images
Section titled “List All Images”DIGITAL_OCEAN_LIST_ALL_IMAGES
Tool to list all images available on your account. Use after obtaining a valid API token to retrieve images optionally filtered by type, private visibility, or tag_name.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to return. Default: 1. Minimum: 1. |
type | string (“distribution” | “application” | “private”) | No | Filter images by type. Valid values: ‘distribution’, ‘application’, ‘private’. |
private | boolean | No | If true, returns only private images. Defaults to false. |
per_page | integer | No | Number of results per page. Default: 20. Range: 1-200. |
tag_name | string | No | Return only images tagged with this tag. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Kubernetes Clusters
Section titled “List All Kubernetes Clusters”DIGITAL_OCEAN_LIST_ALL_KUBERNETES_CLUSTERS
Tool to list all Kubernetes clusters on your account. Use when you need to enumerate every cluster and handle pagination.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number of paginated results (starting from 1). |
per_page | integer | No | Number of clusters per page. Must be between 1 and 200. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Load Balancers
Section titled “List All Load Balancers”DIGITAL_OCEAN_LIST_ALL_LOAD_BALANCERS
List all load balancers in your DigitalOcean account with pagination support. Returns load balancer details including IDs, names, IP addresses, forwarding rules, health checks, sticky sessions, assigned Droplets, and region information.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page of results to return. Must be >= 1. Default is 1. |
per_page | integer | No | Number of items per page. Must be between 1 and 200. Default is 20. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Snapshots
Section titled “List All Snapshots”DIGITAL_OCEAN_LIST_ALL_SNAPSHOTS
Tool to list all snapshots available on your DigitalOcean account. Use when you need to fetch and optionally filter snapshots by resource type (droplet or volume) and handle pagination for inventory or backup workflows.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). |
per_page | integer | No | Number of snapshots to return per page (1-200). |
resource_type | string (“droplet” | “volume”) | No | Filter snapshots by resource type; either ‘droplet’ or ‘volume’. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All SSH Keys
Section titled “List All SSH Keys”DIGITAL_OCEAN_LIST_ALL_SSH_KEYS
Lists all SSH keys associated with your DigitalOcean account. Returns SSH key details including ID, name, public key content, and fingerprint. Supports pagination for accounts with many SSH keys.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). Use with per_page to navigate through paginated results. Omit to get the first page. |
per_page | integer | No | Number of SSH keys to return per page (1-200). Use 200 to retrieve maximum results per request. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Tags
Section titled “List All Tags”DIGITAL_OCEAN_LIST_ALL_TAGS
Tool to list all tags in your account. Use when you need to retrieve available tags and pagination info. A single request returns only one page of results; iterate using page and per_page to retrieve all tags.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (starting from 1). |
per_page | integer | No | Number of items returned per page. Must be between 1 and 200. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All Volumes
Section titled “List All Volumes”DIGITAL_OCEAN_LIST_ALL_VOLUMES
Tool to list all block storage volumes available on your account. Use when you need to retrieve volumes and optionally filter by name and region.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | Filter to return only volumes with this exact name. |
page | integer | No | Page number to retrieve (starting from 1). |
region | string | No | Filter to return only volumes in this region (region slug). |
per_page | integer | No | Number of items returned per page. Must be between 1 and 200. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List All VPCs
Section titled “List All VPCs”DIGITAL_OCEAN_LIST_ALL_VPCS
Tool to list all VPCs on your account. Use when you need an inventory of your VPC resources. A single request returns only one page; iterate through all pages using page and per_page (max 200) to retrieve the complete set.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page number to retrieve (default: 1). |
per_page | integer | No | Number of VPCs to return per page (default: 20, max: 200). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Apps
Section titled “List Apps”DIGITAL_OCEAN_LIST_APPS
Tool to list all App Platform apps in your DigitalOcean account. Use when you need to discover app IDs by name, retrieve app metadata, or enumerate all apps with pagination support.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Which ‘page’ of paginated results to return. Must be >= 1. Default is 1. |
per_page | integer | No | Number of items returned per page. Must be between 1 and 200. Default is 20. |
with_projects | boolean | No | Whether the project_id of listed apps should be fetched and included in the response. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Database Options
Section titled “List Database Options”DIGITAL_OCEAN_LIST_DATABASE_OPTIONS
Lists all available configuration options for DigitalOcean managed database clusters, including supported engines (PostgreSQL, MySQL, MongoDB, Valkey, Kafka, OpenSearch), versions, regions, and cluster sizes/layouts. Use this to discover valid parameter values when creating a new database cluster.
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
List Domain Records
Section titled “List Domain Records”DIGITAL_OCEAN_LIST_DOMAIN_RECORDS
Tool to list all DNS records for a domain. Use when you need to inspect or filter a domain’s DNS configuration.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
page | integer | No | Page of results to return (>= 1). |
type | string (“A” | “AAAA” | “CNAME” | “MX” | “NS” | “TXT” | “SRV” | “LOC” | “CAA”) | No | Filter records by DNS record type. |
per_page | integer | No | Number of results per page (1-200). |
domain_name | string | Yes | The domain name whose records are to be listed (e.g., ‘example.com’). |
record_name | string | No | Filter records by record name (e.g., ‘www’, ’@’ for root domain). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve Domain
Section titled “Retrieve Domain”DIGITAL_OCEAN_RETRIEVE_DOMAIN
Retrieves complete details about a specific domain including its TTL and DNS zone file configuration. Use this when you need to check domain settings, verify DNS configuration, or get the full zone file contents for a domain in your DigitalOcean account.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The fully qualified domain name (e.g., ‘example.com’). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve Domain Record
Section titled “Retrieve Domain Record”DIGITAL_OCEAN_RETRIEVE_DOMAIN_RECORD
Tool to retrieve a specific DNS record for a domain by its record ID. Use when you have the domain name and record ID to fetch record details.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The domain name (e.g., ‘example.com’). |
record_id | integer | Yes | The unique identifier for the DNS record. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve Existing Droplet
Section titled “Retrieve Existing Droplet”DIGITAL_OCEAN_RETRIEVE_EXISTING_DROPLET
Retrieve detailed information about a specific DigitalOcean Droplet by its unique numeric ID. Returns comprehensive droplet details including: current status, specifications (memory, CPU, disk), networking configuration (IPv4/IPv6 addresses), image information, region, VPC, backup settings, attached volumes, and tags.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
droplet_id | integer | Yes | The unique numeric identifier of the Droplet you want to retrieve information about. You can obtain droplet IDs from the List All Droplets action. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve Existing Image
Section titled “Retrieve Existing Image”DIGITAL_OCEAN_RETRIEVE_EXISTING_IMAGE
Tool to retrieve information about an image by ID or slug. Use when you need detailed metadata for a known image.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
image_id | string | Yes | The unique numeric ID or slug of the image to retrieve. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve Tag
Section titled “Retrieve Tag”DIGITAL_OCEAN_RETRIEVE_TAG
Tool to retrieve an individual tag by name. Use when you need to inspect the resources grouped under a specific tag.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name of the tag to retrieve (case-sensitive). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Retrieve VPC
Section titled “Retrieve VPC”DIGITAL_OCEAN_RETRIEVE_VPC
Tool to retrieve details about a specific VPC by its ID. Use when you need to inspect VPC properties for configuration or auditing.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
vpc_uuid | string | Yes | The unique identifier of the VPC. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Tag Resource
Section titled “Tag Resource”DIGITAL_OCEAN_TAG_RESOURCE
Tool to tag resources by name. Use when you need to assign an existing tag to one or more resources. Returns 204 No Content on success.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag_name | string | Yes | The name of the tag to which resources will be assigned. |
resources | array | Yes | List of resources to assign the tag to (each with id and type). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Untag Resource
Section titled “Untag Resource”DIGITAL_OCEAN_UNTAG_RESOURCE
Tool to untag resources by tag name. Use when you need to remove an existing tag from multiple resources in a single operation.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag_name | string | Yes | Name of the tag to remove from the specified resources. |
resources | array | Yes | List of resource objects to untag, each with id, type, and optional region. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update Domain Record
Section titled “Update Domain Record”DIGITAL_OCEAN_UPDATE_DOMAIN_RECORD
Tool to update an existing DNS record for a domain. Use when you need to modify any valid attribute of a record after confirming its record ID.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
tag | string | No | Tag for CAA records. |
ttl | integer | No | Time to live of the record in seconds. |
data | string | No | The value of the DNS record (e.g., IP address for A/AAAA record). |
name | string | No | The host name for the record (e.g., ‘www’, ’@’). |
port | integer | No | Port for SRV records. |
type | string | No | The DNS record type (e.g., ‘A’, ‘CNAME’, ‘TXT’, ‘MX’, ‘SRV’, ‘CAA’). |
flags | integer | No | Flags for CAA records. |
weight | integer | No | Weight for SRV records. |
priority | integer | No | Priority for MX records. |
record_id | integer | Yes | The unique identifier for the DNS record. |
domain_name | string | Yes | The domain name (e.g., ‘example.com’). |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |
Update VPC
Section titled “Update VPC”DIGITAL_OCEAN_UPDATE_VPC
Tool to update information about a VPC. Use when you need to modify the name, description, or default status of an existing VPC.
Input parameters
Section titled “Input parameters”| Name | Type | Required | Description |
|---|---|---|---|
name | string | No | The new name for the VPC. |
vpc_id | string | Yes | The unique identifier of the VPC to update. |
default | boolean | No | Whether to set this VPC as the default for its region. |
description | string | No | A free-form text description for the VPC. |
Output
Section titled “Output”| Name | Type | Required | Description |
|---|---|---|---|
data | string | Yes | Data from the action execution. |
error | string | No | Error if any occurred during the execution of the action. |
successful | boolean | Yes | Whether or not the action execution was successful. |