DigitalOcean Component

Manage your Droplets, Kubernetes clusters, and other DigitalOcean services.

Component key: digitalocean

Description#

DigitalOcean offers cloud computing services to help developers, startups and small and medium-sized businesses rapidly build, deploy and scale applications.

DigitalOcean Connections#

OAuth 2.0#

To connect to DigitalOcean you will need to create a new "OAuth Application" in your dashboard.

Click on "API" in the left hand menu, select the "OAuth Applications" tab, and click "Register OAuth Application". Fill in the required fields and add Prismatic's OAuth 2.0 callback URL: https://oauth2.prismatic.io/callback

Click "Register".

Next, click "More" on the new app you created and select "View". Save the Client ID and Client Secret for the next step.

You are now ready to create the OAuth 2.0 connection to DigitalOcean within Prismatic:

Enter the Client ID and Client Secret you saved earlier into the same named fields.
Enter appropriate scopes into the Scopes field.

Save your integration and you should now be able to authenticate to DigitalOcean.

Input	Default	Notes
Input Authorize URL string / Required Hidden Field	Default https://cloud.digitalocean.com/v1/oauth/authorize	Notes Authorization URL for DigitalOcean
Input Client ID string / Required	Default	Notes Client ID of your DigitalOcean app
Input Client Secret password / Required	Default	Notes Client Secret of your DigitalOcean app
Input Scopes string	Default read	Notes Space delimited scopes; see [DigitalOcean's docs on their scopes](https://docs.digitalocean.com/reference/api/oauth-api/#scopes) for more details
Input Token URL string / Required Hidden Field	Default https://cloud.digitalocean.com/v1/oauth/token	Notes Token URL for DigitalOcean

Actions#

Add Connection Pool#

Add a New Connection Pool (PostgreSQL) | key: addConnectionPool

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Db string / Required	Notes The database for use with the connection pool	Example defaultdb
Input Mode string / Required	Notes The PGBouncer transaction mode for the connection pool	Example transaction
Input Name string / Required	Notes A unique name for the connection pool	Example backend-pool
Input Connection string	Notes	Example
Input Private Connection string	Notes	Example
Input Size string / Required	Notes The desired size of the PGBouncer connection pool	Example 10
Input User string / Required	Notes The name of the user for use with the connection pool	Example doadmin

Add Database#

Add a New Database | key: addDatabase

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Name string / Required	Notes The name of the database	Example alpha

Add Firewall Droplets#

Add Droplets to a Firewall | key: addFirewallDroplets

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Droplet Ids string / Required	Notes An array containing the IDs of the Droplets to be assigned to the firewall	Example 49696269
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall	Example

Add Firewall Rules#

Add Rules to a Firewall | key: addFirewallRules

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall
Input Inbound Rules string	Notes
Input Outbound Rules string	Notes

Add Firewall Tags#

Add Tags to a Firewall | key: addFirewallTags

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall
Input Tags string / Required	Notes

Add Kubernetes Node Pool#

Add a Node Pool to a Kubernetes Cluster | key: addKubernetesNodePool

Input	Default	Notes	Example
Input Auto Scale boolean	Default false	Notes A boolean value indicating whether auto-scaling is enabled for this node pool	Example true
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Default	Notes	Example
Input Count string / Required	Default	Notes The number of Droplet instances in the node pool	Example 3
Input Id string	Default	Notes A unique ID that can be used to identify and reference a specific node pool	Example cdda885e-7663-40c8-bc74-3a036c66545d
Input Labels string	Default	Notes An object containing a set of Kubernetes labels	Example null
Input Max Nodes string	Default	Notes The maximum number of nodes that this node pool can be auto-scaled to	Example 6
Input Min Nodes string	Default	Notes The minimum number of nodes that this node pool can be auto-scaled to	Example 3
Input Name string / Required	Default	Notes A human-readable name for the node pool	Example frontend-pool
Input Nodes string	Default	Notes An object specifying the details of a specific worker node in a node pool	Example
Input Size string / Required	Default	Notes The slug identifier for the type of Droplet used as workers in the node pool	Example s-1vcpu-2gb
Input Tags string	Default	Notes An array containing the tags applied to the node pool	Example k8s,k8s:bd5f5959-5e1e-4205-a714-a914373942af,k8s-worker,production,web-team
Input Taints string	Default	Notes An array of taints to apply to all nodes in a pool	Example

Add Load Balancer Droplets#

Add Droplets to a Load Balancer | key: addLoadBalancerDroplets

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Droplet Ids string / Required	Notes An array containing the IDs of the Droplets assigned to the load balancer	Example 3164444,3164445
Input Lb Id string / Required	Notes A unique identifier for a load balancer	Example

Add Load Balancer Forwarding Rules#

Add Forwarding Rules to a Load Balancer | key: addLoadBalancerForwardingRules

Input	Notes
Input Connection connection / Required	Notes
Input Forwarding Rules string / Required	Notes
Input Lb Id string / Required	Notes A unique identifier for a load balancer

Add Registry#

Add Container Registry to Kubernetes Clusters | key: addRegistry

Input	Notes	Example
Input Cluster Uuids string	Notes An array containing the UUIDs of Kubernetes clusters	Example bd5f5959-5e1e-4205-a714-a914373942af,50c2f44c-011d-493e-aee5-361a4a0d1844
Input Connection connection / Required	Notes	Example

Add User#

Add a Database User | key: addUser

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Mysql Settings string	Notes	Example
Input Name string / Required	Notes The name of a database user	Example app-01
Input Password string	Notes A randomly generated password for the database user	Example jge5lfxtzhx42iff
Input Role string	Notes A string representing the database user"s role	Example normal

Assign Alert Destinations#

Update destinations for alerts | key: assignAlertDestinations

Input	Notes	Example
Input Alert Id string / Required	Notes The alert ID	Example
Input App Id string / Required	Notes The app ID	Example
Input Connection connection / Required	Notes	Example
Input Emails string	Notes	Example sammy@digitalocean.com
Input Slack Webhooks string	Notes	Example

Assign Default Project Resources#

Assign Resources to Default Project | key: assignDefaultProjectResources

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Resources string	Notes A list of uniform resource names (URNs) to be added to a project	Example do:droplet:13457723

Assign Project Resources#

Assign Resources to a Project | key: assignProjectResources

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Project Id string / Required	Notes A unique identifier for a project	Example
Input Resources string	Notes A list of uniform resource names (URNs) to be added to a project	Example do:droplet:13457723

Create Alert Policy#

Create Alert Policy | key: createAlertPolicy

Input	Default	Notes	Example
Input Alerts string / Required	Default	Notes	Example
Input Compare string / Required	Default	Notes	Example GreaterThan
Input Connection connection / Required	Default	Notes	Example
Input Description string / Required	Default	Notes	Example CPU Alert
Input Enabled boolean / Required	Default false	Notes	Example true
Input Entities string / Required	Default	Notes	Example 192018292
Input Tags string / Required	Default	Notes	Example droplet_tag
Input Type string / Required	Default	Notes	Example v1/insights/droplet/cpu
Input Value string / Required	Default	Notes	Example 80
Input Window string / Required	Default	Notes	Example 5m

Create App#

Create a New App | key: createApp

Input	Notes
Input Connection connection / Required	Notes
Input Spec string / Required	Notes The desired configuration of an application

Create App Rollback#

Rollback App | key: createAppRollback

Input	Default	Notes	Example
Input App Id string / Required	Default	Notes The app ID	Example
Input Connection connection / Required	Default	Notes	Example
Input Deployment Id string	Default	Notes The ID of the deployment to rollback to	Example 3aa4d20e-5527-4c00-b496-601fbd22520a
Input Skip Pin boolean	Default false	Notes Whether to skip pinning the rollback deployment	Example false

Create Cdn Endpoint#

Create a New CDN Endpoint | key: createCdnEndpoint

Input	Default	Notes	Example
Input Certificate Id string	Default	Notes The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided	Example 892071a0-bb95-49bc-8021-3afd67a210bf
Input Connection connection / Required	Default	Notes	Example
Input Created At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the CDN endpoint was created	Example Wed Mar 21 2018 09:02:37 GMT-0700 (Mountain Standard Time)
Input Custom Domain string	Default	Notes The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint	Example static.example.com
Input Endpoint string	Default	Notes The fully qualified domain name (FQDN) from which the CDN-backed content is served	Example static-images.nyc3.cdn.digitaloceanspaces.com
Input Id string	Default	Notes A unique ID that can be used to identify and reference a CDN endpoint	Example 892071a0-bb95-49bc-8021-3afd67a210bf
Input Origin string / Required	Default	Notes The fully qualified domain name (FQDN) for the origin server which provides the content for the CDN	Example static-images.nyc3.digitaloceanspaces.com
Input Ttl string	Default 3600	Notes The amount of time the content is cached by the CDN"s edge servers in seconds	Example 3600

Create Certificates#

Create a New Certificate | key: createCertificates

Input	Notes
Input Connection connection / Required	Notes

Create Custom Image#

Create a Custom Image | key: createCustomImage

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Description string	Notes An optional free-form text field to describe an image	Example
Input Distribution string	Notes The name of a custom image"s distribution	Example Ubuntu
Input Name string / Required	Notes The display name that has been given to an image	Example Nifty New Snapshot
Input Region string / Required	Notes The slug identifier for the region where the resource will initially be available	Example nyc3
Input Tags string	Notes A flat array of tag names as strings to be applied to the resource	Example base-image,prod
Input Url string / Required	Notes A URL from which the custom Linux virtual machine image may be retrieved	Example http://cloud-images.ubuntu.com/minimal/releases/bionic/release/ubuntu-18.04-minimal-cloudimg-amd64.img

Create Database Cluster#

Create a New Database Cluster | key: createDatabaseCluster

Input	Notes	Example
Input Backup Restore string	Notes	Example
Input Connection connection / Required	Notes	Example
Input Created At string	Notes A time value given in ISO8601 combined date and time format that represents when the database cluster was created	Example Fri Jan 11 2019 11:37:36 GMT-0700 (Mountain Standard Time)
Input Db Names string	Notes An array of strings containing the names of databases created in the database cluster	Example doadmin
Input Engine string	Notes A slug representing the database engine used for the cluster	Example pg
Input Id string	Notes A unique ID that can be used to identify and reference a database cluster	Example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30
Input Maintenance Window string	Notes	Example
Input Name string	Notes A unique, human-readable name referring to a database cluster	Example backend
Input Num Nodes string	Notes The number of nodes in the database cluster	Example 2
Input Connection string	Notes	Example
Input Private Connection string	Notes	Example
Input Private Network Uuid string	Notes A string specifying the UUID of the VPC to which the database cluster will be assigned	Example d455e75d-4858-4eec-8c95-da2f0a5f93a7
Input Region string	Notes The slug identifier for the region where the database cluster is located	Example nyc3
Input Size string	Notes The slug identifier representing the size of the nodes in the database cluster	Example db-s-2vcpu-4gb
Input Status string	Notes A string representing the current status of the database cluster	Example creating
Input Tags string	Notes An array of tags that have been applied to the database cluster	Example production
Input Users string	Notes	Example
Input Version string	Notes A string representing the version of the database engine in use for the cluster	Example 10

Create Deployment#

Create an App Deployment | key: createDeployment

Input	Default	Notes	Example
Input App Id string / Required	Default	Notes The app ID	Example
Input Connection connection / Required	Default	Notes	Example
Input Force Build boolean	Default false	Notes	Example true

Create Domain#

Create a New Domain | key: createDomain

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Ip Address string	Notes This optional attribute may contain an IP address	Example 192.0.2.1
Input Name string	Notes The name of the domain itself	Example example.com
Input Ttl string	Notes This value is the time to live for the records on this domain, in seconds	Example 1800
Input Zone File string	Notes This attribute contains the complete contents of the zone file for the selected domain	Example $ORIGIN example.com. $TTL 1800 example.com. IN SOA ns1.digitalocean.com. hostmaster.example.com. 1415982609 10800 3600 604800 1800 example.com. 1800 IN NS ns1.digitalocean.com. example.com. 1800 IN NS ns2.digitalocean.com. example.com. 1800 IN NS ns3.digitalocean.com. example.com. 1800 IN A 1.2.3.4

Create Domain Record#

Create a New Domain Record | key: createDomainRecord

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself

Create Droplet#

Create a New Droplet | key: createDroplet

Input	Notes
Input Connection connection / Required	Notes

Create Firewall#

Create a New Firewall | key: createFirewall

Input	Notes
Input Connection connection / Required	Notes

Create Floating Ip#

Create a New Floating IP | key: createFloatingIp

Input	Notes
Input Connection connection / Required	Notes

Create Kubernetes Cluster#

Create a New Kubernetes Cluster | key: createKubernetesCluster

Input	Default	Notes	Example
Input Auto Upgrade boolean	Default false	Notes A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window	Example true
Input Cluster Subnet string	Default	Notes The range of IP addresses in the overlay network of the Kubernetes cluster in CIDR notation	Example 10.244.0.0/16
Input Connection connection / Required	Default	Notes	Example
Input Created At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was created	Example Thu Nov 15 2018 09:00:11 GMT-0700 (Mountain Standard Time)
Input Endpoint string	Default	Notes The base URL of the API server on the Kubernetes master node	Example https://bd5f5959-5e1e-4205-a714-a914373942af.k8s.ondigitalocean.com
Input Ha boolean	Default false	Notes A boolean value indicating whether the control plane is run in a highly available configuration in the cluster	Example true
Input Id string	Default	Notes A unique ID that can be used to identify and reference a Kubernetes cluster	Example bd5f5959-5e1e-4205-a714-a914373942af
Input Ipv 4 string	Default	Notes The public IPv4 address of the Kubernetes master node	Example 68.183.121.157
Input Maintenance Policy string	Default	Notes An object specifying the maintenance window policy for the Kubernetes cluster	Example
Input Name string / Required	Default	Notes A human-readable name for a Kubernetes cluster	Example prod-cluster-01
Input Node Pools string / Required	Default	Notes An object specifying the details of the worker nodes available to the Kubernetes cluster	Example
Input Region string / Required	Default	Notes The slug identifier for the region where the Kubernetes cluster is located	Example nyc1
Input Registry Enabled boolean	Default false	Notes A read-only boolean value indicating if a container registry is integrated with the cluster	Example true
Input Service Subnet string	Default	Notes The range of assignable IP addresses for services running in the Kubernetes cluster in CIDR notation	Example 10.245.0.0/16
Input Status string	Default	Notes An object containing a "state" attribute whose value is set to a string indicating the current status of the cluster	Example
Input Surge Upgrade boolean	Default false	Notes A boolean value indicating whether surge upgrade is enabled/disabled for the cluster	Example true
Input Tags string	Default	Notes An array of tags applied to the Kubernetes cluster	Example k8s,k8s:bd5f5959-5e1e-4205-a714-a914373942af,production,web-team
Input Updated At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the Kubernetes cluster was last updated	Example Thu Nov 15 2018 09:00:11 GMT-0700 (Mountain Standard Time)
Input Version string / Required	Default	Notes The slug identifier for the version of Kubernetes used for the cluster	Example 1.18.6-do.0
Input Vpc Uuid string	Default	Notes A string specifying the UUID of the VPC to which the Kubernetes cluster is assigned	Example c33931f2-a26a-4e61-b85c-4e95a2ec431b

Create Load Balancer#

Create a New Load Balancer | key: createLoadBalancer

Input	Notes
Input Connection connection / Required	Notes

Create New Tag#

Create a New Tag | key: createNewTag

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes The name of the tag	Example extra-awesome
Input Resources string	Notes An embedded object containing key value pairs of resource type and resource statistics	Example [object Object]

Create New Volume#

Create a New Block Storage Volume | key: createNewVolume

Input	Notes
Input Connection connection / Required	Notes

Create Project#

Create a Project | key: createProject

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Created At string	Notes A time value given in ISO8601 combined date and time format that represents when the project was created	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)
Input Description string	Notes The description of the project	Example My website API
Input Environment string	Notes The environment of the project"s resources	Example Production
Input Id string	Notes The unique universal identifier of this project	Example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679
Input Name string / Required	Notes The human-readable name for the project	Example my-web-api
Input Owner Id string	Notes The integer id of the project owner	Example 258992
Input Owner Uuid string	Notes The unique universal identifier of the project owner	Example 99525febec065ca37b2ffe4f852fd2b2581895e7
Input Purpose string / Required	Notes The purpose of the project	Example Service or API
Input Updated At string	Notes A time value given in ISO8601 combined date and time format that represents when the project was updated	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)

Create Registry#

Create Container Registry | key: createRegistry

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes A globally unique name for the container registry	Example example
Input Region string	Notes Slug of the region where registry data is stored	Example fra1
Input Subscription Tier Slug string / Required	Notes The slug of the subscription tier to sign up for	Example basic

Create Replica#

Create a Read-only Replica | key: createReplica

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Created At string	Notes A time value given in ISO8601 combined date and time format that represents when the database cluster was created	Example Fri Jan 11 2019 11:37:36 GMT-0700 (Mountain Standard Time)
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Name string / Required	Notes The name to give the read-only replicating	Example read-nyc3-01
Input Connection string	Notes	Example
Input Private Connection string	Notes	Example
Input Private Network Uuid string	Notes A string specifying the UUID of the VPC to which the read-only replica will be assigned	Example 9423cbad-9211-442f-820b-ef6915e99b5f
Input Region string	Notes A slug identifier for the region where the read-only replica will be located	Example nyc3
Input Size string / Required	Notes A slug identifier representing the size of the node for the read-only replica	Example db-s-2vcpu-4gb
Input Status string	Notes A string representing the current status of the database cluster	Example creating
Input Tags string	Notes A flat array of tag names as strings to apply to the read-only replica after it is created	Example production

Create Ssh Key#

Create a New SSH Key | key: createSshKey

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Fingerprint string	Notes A unique identifier that differentiates this key from other keys using a format that SSH recognizes	Example 3b:16:bf:e4:8b:00:8b:b8:59:8c:a9:d3:f0:19:45:fa
Input Id string	Notes A unique identification number for this key	Example 512189
Input Name string / Required	Notes A human-readable display name for this key, used to easily identify the SSH keys when they are displayed	Example My SSH Public Key
Input Public Key string / Required	Notes The entire public key string that was uploaded	Example ssh-rsa AEXAMPLEaC1yc2EAAAADAQABAAAAQQDDHr/jh2Jy4yALcK4JyWbVkPRaWmhck3IgCoeOO3z1e2dBowLh64QAM+Qb72pxekALga2oi4GvT+TlWNhzPH4V example

Create Volume Snapshot#

Create Snapshot from a Volume | key: createVolumeSnapshot

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes A human-readable name for the volume snapshot	Example big-data-snapshot1475261774
Input Tags string	Notes A flat array of tag names as strings to be applied to the resource	Example base-image,prod
Input Volume Id string / Required	Notes The ID of the block storage volume	Example

Create Vpc#

Create a New VPC | key: createVpc

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Description string	Notes A free-form text field for describing the VPC"s purpose	Example VPC for production environment
Input Ip Range string	Notes The range of IP addresses in the VPC in CIDR notation	Example 10.10.10.0/24
Input Name string / Required	Notes The name of the VPC	Example env.prod-vpc
Input Region string / Required	Notes The slug identifier for the region where the VPC will be created	Example nyc1

Delete Alert Policy#

Delete an Alert Policy | key: deleteAlertPolicy

Input	Notes
Input Alert Uuid string / Required	Notes A unique identifier for an alert policy
Input Connection connection / Required	Notes

Delete App#

Delete an App | key: deleteApp

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes The ID of the app

Delete Cdn Endpoint#

Delete a CDN Endpoint | key: deleteCdnEndpoint

Input	Notes
Input Cdn Id string / Required	Notes A unique identifier for a CDN endpoint
Input Connection connection / Required	Notes

Delete Certificate#

Delete a Certificate | key: deleteCertificate

Input	Notes
Input Certificate Id string / Required	Notes A unique identifier for a certificate
Input Connection connection / Required	Notes

Delete Connection Pool#

Delete a Connection Pool (PostgreSQL) | key: deleteConnectionPool

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Pool Name string / Required	Notes The name used to identify the connection pool

Delete Database#

Delete a Database | key: deleteDatabase

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Database Name string / Required	Notes The name of the database

Delete Domain#

Delete a Domain | key: deleteDomain

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself

Delete Domain Record#

Delete a Domain Record | key: deleteDomainRecord

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself
Input Domain Record Id string / Required	Notes The unique identifier of the domain record

Delete Firewall#

Delete a Firewall | key: deleteFirewall

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall

Delete Firewall Droplets#

Remove Droplets from a Firewall | key: deleteFirewallDroplets

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Droplet Ids string / Required	Notes An array containing the IDs of the Droplets to be removed from the firewall	Example 49696269
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall	Example

Delete Firewall Rules#

Remove Rules from a Firewall | key: deleteFirewallRules

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall
Input Inbound Rules string	Notes
Input Outbound Rules string	Notes

Delete Firewall Tags#

Remove Tags from a Firewall | key: deleteFirewallTags

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall
Input Tags string / Required	Notes

Delete Floating Ip#

Delete a Floating IPs | key: deleteFloatingIp

Input	Notes
Input Connection connection / Required	Notes
Input Floating Ip string / Required	Notes A floating IP address

Delete Image#

Delete an Image | key: deleteImage

Input	Notes
Input Connection connection / Required	Notes
Input Image Id string / Required	Notes A unique number that can be used to identify and reference a specific image

Delete Kubernetes Cluster#

Delete a Kubernetes Cluster | key: deleteKubernetesCluster

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

Delete Kubernetes Node#

Delete a Node in a Kubernetes Cluster | key: deleteKubernetesNode

Input	Default	Notes
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Default	Notes
Input Node Id string / Required	Default	Notes A unique ID that can be used to reference a node in a Kubernetes node pool
Input Node Pool Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes node pool
Input Replace string	Default 0	Notes Specifies whether or not to replace a node after it has been deleted
Input Skip Drain string	Default 0	Notes Specifies whether or not to drain workloads from a node before it is deleted

Delete Kubernetes Node Pool#

Delete a Node Pool in a Kubernetes Cluster | key: deleteKubernetesNodePool

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes
Input Node Pool Id string / Required	Notes A unique ID that can be used to reference a Kubernetes node pool

Delete Load Balancer#

Delete a Load Balancer | key: deleteLoadBalancer

Input	Notes
Input Connection connection / Required	Notes
Input Lb Id string / Required	Notes A unique identifier for a load balancer

Delete Online Migration#

Stop an Online Migration | key: deleteOnlineMigration

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Migration Id string / Required	Notes A unique identifier assigned to the online migration

Delete Project#

Delete an Existing Project | key: deleteProject

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes A unique identifier for a project

Delete Registry#

Delete Container Registry | key: deleteRegistry

Input	Notes
Input Connection connection / Required	Notes

Delete Repository Manifest#

Delete Container Registry Repository Manifest | key: deleteRepositoryManifest

Input	Notes
Input Connection connection / Required	Notes
Input Manifest Digest string / Required	Notes The manifest digest of a container registry repository tag
Input Registry Name string / Required	Notes The name of a container registry
Input Repository Name string / Required	Notes The name of a container registry repository

Delete Repository Tag#

Delete Container Registry Repository Tag | key: deleteRepositoryTag

Input	Notes
Input Connection connection / Required	Notes
Input Registry Name string / Required	Notes The name of a container registry
Input Repository Name string / Required	Notes The name of a container registry repository
Input Repository Tag string / Required	Notes The name of a container registry repository tag

Delete Snapshot#

Delete a Snapshot | key: deleteSnapshot

Input	Notes
Input Connection connection / Required	Notes
Input Snapshot Id string / Required	Notes Either the ID of an existing snapshot

Delete Tag#

Delete a Tag | key: deleteTag

Input	Notes
Input Connection connection / Required	Notes
Input Tag Id string / Required	Notes The name of the tag

Delete User#

Remove a Database User | key: deleteUser

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Username string / Required	Notes The name of the database user

Delete Volume#

Delete a Block Storage Volume | key: deleteVolume

Input	Notes
Input Connection connection / Required	Notes
Input Volume Id string / Required	Notes The ID of the block storage volume

Delete Volume By Name#

Delete a Block Storage Volume by Name | key: deleteVolumeByName

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes The block storage volume"s name	Example
Input Region string	Notes The slug identifier for the region where the resource is available	Example nyc3

Delete Volume Snapshot By Id#

Delete a Volume Snapshot | key: deleteVolumeSnapshotById

Input	Notes
Input Connection connection / Required	Notes
Input Snapshot Id string / Required	Notes Either the ID of an existing snapshot

Delete Vpc#

Delete a VPC | key: deleteVpc

Input	Notes
Input Connection connection / Required	Notes
Input Vpc Id string / Required	Notes A unique identifier for a VPC

Destroy Cluster#

Destroy a Database Cluster | key: destroyCluster

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Destroy Droplet#

Delete an Existing Droplet | key: destroyDroplet

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Destroy Droplets By Tag#

Deleting Droplets by Tag | key: destroyDropletsByTag

Input	Notes
Input Connection connection / Required	Notes
Input Tag Name string / Required	Notes Specifies Droplets to be deleted by tag

Destroy Kubernetes Associated Resources Dangerous#

Delete a Cluster and All of its Associated Resources (Dangerous) | key: destroyKubernetesAssociatedResourcesDangerous

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

Destroy Kubernetes Associated Resources Selective#

Selectively Delete a Cluster and its Associated Resources | key: destroyKubernetesAssociatedResourcesSelective

Input	Notes	Example
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Notes	Example
Input Load Balancers string	Notes A list of IDs for associated load balancers to destroy along with the cluster	Example 4de7ac8b-495b-4884-9a69-1050c6793cd6
Input Volumes string	Notes A list of IDs for associated volumes to destroy along with the cluster	Example ba49449a-7435-11ea-b89e-0a58ac14480f
Input Volume Snapshots string	Notes A list of IDs for associated volume snapshots to destroy along with the cluster	Example edb0478d-7436-11ea-86e6-0a58ac144b91

Destroy Replica#

Destroy a Read-only Replica | key: destroyReplica

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Replica Name string / Required	Notes The name of the database replica

Destroy Ssh Key#

Delete an SSH Key | key: destroySshKey

Input	Notes
Input Connection connection / Required	Notes
Input Ssh Key Identifier string / Required	Notes Either the ID or the fingerprint of an existing SSH key

Destroy With Associated Resources Dangerous#

Destroy a Droplet and All of its Associated Resources (Dangerous) | key: destroyWithAssociatedResourcesDangerous

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Destroy With Associated Resources Selective#

Selectively Destroy a Droplet and its Associated Resources | key: destroyWithAssociatedResourcesSelective

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Get Action#

Retrieve an Existing Action | key: getAction

Input	Notes
Input Action Id string / Required	Notes A unique numeric ID that can be used to identify and reference an action
Input Connection connection / Required	Notes

Get Alert Policy#

Retrieve an Existing Alert Policy | key: getAlertPolicy

Input	Notes
Input Alert Uuid string / Required	Notes A unique identifier for an alert policy
Input Connection connection / Required	Notes

Get App#

Retrieve an Existing App | key: getApp

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes The ID of the app
Input Name string	Notes The name of the app to retrieve

Get Available Upgrades#

Retrieve Available Upgrades for an Existing Kubernetes Cluster | key: getAvailableUpgrades

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

Get Ca#

Retrieve the Public Certificate | key: getCa

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Cdn Endpoint#

Retrieve an Existing CDN Endpoint | key: getCdnEndpoint

Input	Notes
Input Cdn Id string / Required	Notes A unique identifier for a CDN endpoint
Input Connection connection / Required	Notes

Get Certificate#

Retrieve an Existing Certificate | key: getCertificate

Input	Notes
Input Certificate Id string / Required	Notes A unique identifier for a certificate
Input Connection connection / Required	Notes

Get Cluster User#

Retrieve User Information for a Kubernetes Cluster | key: getClusterUser

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

Get Clusterlint Results#

Fetch Clusterlint Diagnostics for a Kubernetes Cluster | key: getClusterlintResults

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes
Input Run Id string	Notes Specifies the clusterlint run whose results will be retrieved

Get Connection Pool#

Retrieve Existing Connection Pool (PostgreSQL) | key: getConnectionPool

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Pool Name string / Required	Notes The name used to identify the connection pool

Get Credentials#

Retrieve Credentials for a Kubernetes Cluster | key: getCredentials

Input	Default	Notes
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Default	Notes
Input Expiry Seconds string	Default 0	Notes The duration in seconds that the returned Kubernetes credentials will be valid

Get Customer Balance#

Get Customer Balance | key: getCustomerBalance

Input	Notes
Input Connection connection / Required	Notes

Get Database#

Retrieve an Existing Database | key: getDatabase

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Database Name string / Required	Notes The name of the database

Get Database Cluster#

Retrieve an Existing Database Cluster | key: getDatabaseCluster

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Database Config#

Retrieve an Existing Database Cluster Configuration | key: getDatabaseConfig

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Default Project#

Retrieve the Default Project | key: getDefaultProject

Input	Notes
Input Connection connection / Required	Notes

Get Deployment#

Retrieve an App Deployment | key: getDeployment

Input	Notes
Input App Id string / Required	Notes The app ID
Input Connection connection / Required	Notes
Input Deployment Id string / Required	Notes The deployment ID

Get Destroy With Associated Resources Status#

Check Status of a Droplet Destroy with Associated Resources Request | key: getDestroyWithAssociatedResourcesStatus

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Get Docker Credentials#

Get Docker Credentials for Container Registry | key: getDockerCredentials

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Expiry Seconds string	Default 0	Notes The duration in seconds that the returned registry credentials will be valid
Input Read Write boolean	Default false	Notes By default, the registry credentials allow for read-only access

Get Domain#

Retrieve an Existing Domain | key: getDomain

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself

Get Domain Record#

Retrieve an Existing Domain Record | key: getDomainRecord

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself
Input Domain Record Id string / Required	Notes The unique identifier of the domain record

Get Droplet#

Retrieve an Existing Droplet | key: getDroplet

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Get Droplet Action#

Retrieve a Droplet Action | key: getDropletAction

Input	Notes
Input Action Id string / Required	Notes A unique numeric ID that can be used to identify and reference an action
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Get Droplet Bandwidth Metrics#

Get Droplet Bandwidth Metrics | key: getDropletBandwidthMetrics

Input	Notes
Input Interface string / Required	Notes The network interface
Input Connection connection / Required	Notes
Input Direction string / Required	Notes The traffic direction
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Cpu Metrics#

Get Droplet CPU Metrics | key: getDropletCpuMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Filesystem Free Metrics#

Get Droplet Filesystem Free Metrics | key: getDropletFilesystemFreeMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Filesystem Size Metrics#

Get Droplet Filesystem Size Metrics | key: getDropletFilesystemSizeMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Load 1 Metrics#

Get Droplet Load1 Metrics | key: getDropletLoad1Metrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Load 15 Metrics#

Get Droplet Load15 Metrics | key: getDropletLoad15Metrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Load 5 Metrics#

Get Droplet Load5 Metrics | key: getDropletLoad5Metrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Memory Available Metrics#

Get Droplet Available Memory Metrics | key: getDropletMemoryAvailableMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Memory Cached Metrics#

Get Droplet Cached Memory Metrics | key: getDropletMemoryCachedMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Memory Free Metrics#

Get Droplet Free Memory Metrics | key: getDropletMemoryFreeMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Droplet Memory Total Metrics#

Get Droplet Total Memory Metrics | key: getDropletMemoryTotalMetrics

Input	Notes
Input Connection connection / Required	Notes
Input End string / Required	Notes Timestamp to end metric window
Input Host Id string / Required	Notes The droplet ID
Input Start string / Required	Notes Timestamp to start metric window

Get Eviction Policy#

Retrieve the Eviction Policy for a Redis Cluster | key: getEvictionPolicy

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Firewall#

Retrieve an Existing Firewall | key: getFirewall

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall

Get Floating Ip#

Retrieve an Existing Floating IP | key: getFloatingIp

Input	Notes
Input Connection connection / Required	Notes
Input Floating Ip string / Required	Notes A floating IP address

Get Floating Ip Action#

Retrieve an Existing Floating IP Action | key: getFloatingIpAction

Input	Notes
Input Action Id string / Required	Notes A unique numeric ID that can be used to identify and reference an action
Input Connection connection / Required	Notes
Input Floating Ip string / Required	Notes A floating IP address

Get Garbage Collection#

Get Active Garbage Collection | key: getGarbageCollection

Input	Notes
Input Connection connection / Required	Notes
Input Registry Name string / Required	Notes The name of a container registry

Get Image#

Retrieve an Existing Image | key: getImage

Input	Notes
Input Connection connection / Required	Notes
Input Image Id string / Required	Notes A unique number (id) or string (slug) used to identify and reference a

Get Image Action#

Retrieve an Existing Action | key: getImageAction

Input	Notes
Input Action Id string / Required	Notes A unique numeric ID that can be used to identify and reference an action
Input Connection connection / Required	Notes
Input Image Id string / Required	Notes A unique number that can be used to identify and reference a specific image

Get Images List#

List All Images | key: getImagesList

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Private boolean	Default false	Notes Used to filter only user images
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Tag Name string	Default	Notes Used to filter images by a specific tag
Input Type string	Default	Notes Filters results based on image type which can be either "application" or "distribution"

Get Instance Size#

Retrieve an Instance Size | key: getInstanceSize

Input	Notes
Input Connection connection / Required	Notes
Input Slug string / Required	Notes The slug of the instance size

Get Invoice By Uuid#

Retrieve an Invoice by UUID | key: getInvoiceByUuid

Input	Notes
Input Connection connection / Required	Notes
Input Invoice Uuid string / Required	Notes UUID of the invoice

Get Invoice Csv By Uuid#

Retrieve an Invoice CSV by UUID | key: getInvoiceCsvByUuid

Input	Notes
Input Connection connection / Required	Notes
Input Invoice Uuid string / Required	Notes UUID of the invoice

Get Invoice Pdf By Uuid#

Retrieve an Invoice PDF by UUID | key: getInvoicePdfByUuid

Input	Notes
Input Connection connection / Required	Notes
Input Invoice Uuid string / Required	Notes UUID of the invoice

Get Invoice Summary By Uuid#

Retrieve an Invoice Summary by UUID | key: getInvoiceSummaryByUuid

Input	Notes
Input Connection connection / Required	Notes
Input Invoice Uuid string / Required	Notes UUID of the invoice

Get Kubeconfig#

Retrieve the kubeconfig for a Kubernetes Cluster | key: getKubeconfig

Input	Default	Notes
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Default	Notes
Input Expiry Seconds string	Default 0	Notes The duration in seconds that the returned Kubernetes credentials will be valid

Get Kubernetes Cluster#

Retrieve an Existing Kubernetes Cluster | key: getKubernetesCluster

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

Get Load Balancer#

Retrieve an Existing Load Balancer | key: getLoadBalancer

Input	Notes
Input Connection connection / Required	Notes
Input Lb Id string / Required	Notes A unique identifier for a load balancer

Get Logs#

Retrieve Deployment Logs | key: getLogs

Input	Default	Notes
Input App Id string / Required	Default	Notes The app ID
Input Component Name string / Required	Default	Notes An optional component name
Input Connection connection / Required	Default	Notes
Input Deployment Id string / Required	Default	Notes The deployment ID
Input Follow boolean	Default false	Notes Whether the logs should follow live updates
Input Pod Connection Timeout string	Default	Notes An optional time duration to wait if the underlying component instance is not immediately available
Input Type string / Required	Default UNSPECIFIED	Notes The type of logs to retrieve

Get Logs Aggregate#

Retrieve Aggregate Deployment Logs | key: getLogsAggregate

Input	Default	Notes
Input App Id string / Required	Default	Notes The app ID
Input Connection connection / Required	Default	Notes
Input Deployment Id string / Required	Default	Notes The deployment ID
Input Follow boolean	Default false	Notes Whether the logs should follow live updates
Input Pod Connection Timeout string	Default	Notes An optional time duration to wait if the underlying component instance is not immediately available
Input Type string / Required	Default UNSPECIFIED	Notes The type of logs to retrieve

Get Migration Status#

Retrieve the Status of an Online Migration | key: getMigrationStatus

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Node Pool#

Retrieve a Node Pool for a Kubernetes Cluster | key: getNodePool

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes
Input Node Pool Id string / Required	Notes A unique ID that can be used to reference a Kubernetes node pool

Get Project#

Retrieve an Existing Project | key: getProject

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes A unique identifier for a project

Get Registry#

Get Container Registry Information | key: getRegistry

Input	Notes
Input Connection connection / Required	Notes

Get Registry Options#

List Registry Options (Subscription Tiers and Available Regions) | key: getRegistryOptions

Input	Notes
Input Connection connection / Required	Notes

Get Registry Subscription#

Get Subscription Information | key: getRegistrySubscription

Input	Notes
Input Connection connection / Required	Notes

Get Replica#

Retrieve an Existing Read-only Replica | key: getReplica

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Replica Name string / Required	Notes The name of the database replica

Get Snapshot#

Retrieve an Existing Snapshot | key: getSnapshot

Input	Notes
Input Connection connection / Required	Notes
Input Snapshot Id string / Required	Notes Either the ID of an existing snapshot

Get Sql Mode#

Retrieve the SQL Modes for a MySQL Cluster | key: getSqlMode

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Get Ssh Key#

Retrieve an Existing SSH Key | key: getSshKey

Input	Notes
Input Connection connection / Required	Notes
Input Ssh Key Identifier string / Required	Notes Either the ID or the fingerprint of an existing SSH key

Get Tag#

Retrieve a Tag | key: getTag

Input	Notes
Input Connection connection / Required	Notes
Input Tag Id string / Required	Notes The name of the tag

Get Tier#

Retrieve an App Tier | key: getTier

Input	Notes
Input Connection connection / Required	Notes
Input Slug string / Required	Notes The slug of the tier

Get User#

Retrieve an Existing Database User | key: getUser

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Username string / Required	Notes The name of the database user

Get User Information#

Get User Information | key: getUserInformation

Input	Notes
Input Connection connection / Required	Notes

Get Volume#

Retrieve an Existing Block Storage Volume | key: getVolume

Input	Notes
Input Connection connection / Required	Notes
Input Volume Id string / Required	Notes The ID of the block storage volume

Get Volume Action#

Retrieve an Existing Volume Action | key: getVolumeAction

Input	Default	Notes
Input Action Id string / Required	Default	Notes A unique numeric ID that can be used to identify and reference an action
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Volume Id string / Required	Default	Notes The ID of the block storage volume

Get Volume Snapshot By Id#

Retreive an Existing Volume Snapshot | key: getVolumeSnapshotById

Input	Notes
Input Connection connection / Required	Notes
Input Snapshot Id string / Required	Notes Either the ID of an existing snapshot

Get Vpc#

Retrieve an Existing VPC | key: getVpc

Input	Notes
Input Connection connection / Required	Notes
Input Vpc Id string / Required	Notes A unique identifier for a VPC

Install Kubernetes#

Install Kubernetes 1-Click Applications | key: installKubernetes

Input	Notes	Example
Input Addon Slugs string / Required	Notes An array of 1-Click Application slugs to be installed to the Kubernetes cluster	Example kube-state-metrics,loki
Input Cluster Uuid string / Required	Notes A unique ID for the Kubernetes cluster to which the 1-Click Applications will be installed	Example 50a994b6-c303-438f-9495-7e896cfe6b08
Input Connection connection / Required	Notes	Example

List#

List 1-Click Applications | key: list

Input	Notes
Input Connection connection / Required	Notes
Input Type string	Notes Restrict results to a certain type of 1-Click

List Alert Policies#

List Alert Policies | key: listAlertPolicies

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Alerts#

List all app alerts | key: listAlerts

Input	Notes
Input App Id string / Required	Notes The app ID
Input Connection connection / Required	Notes

List All Actions#

List All Actions | key: listAllActions

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Domain Records#

List All Domain Records | key: listAllDomainRecords

Input	Notes
Input Connection connection / Required	Notes
Input Domain Name string / Required	Notes The name of the domain itself
Input Name string	Notes A fully qualified record name
Input Type string	Notes The type of the DNS record

List All Domains#

List All Domains | key: listAllDomains

Input	Notes
Input Connection connection / Required	Notes

List All Droplet Neighbors Ids#

List All Droplet Neighbors | key: listAllDropletNeighborsIds

Input	Notes
Input Connection connection / Required	Notes

List All Droplets#

List All Droplets | key: listAllDroplets

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Tag Name string	Default	Notes Used to filter Droplets by a specific tag

List All Keys#

List All SSH Keys | key: listAllKeys

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Kubernetes Clusters#

List All Kubernetes Clusters | key: listAllKubernetesClusters

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Load Balancers#

List All Load Balancers | key: listAllLoadBalancers

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Regions#

List All Data Center Regions | key: listAllRegions

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Sizes#

List All Droplet Sizes | key: listAllSizes

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List All Snapshots#

List All Snapshots | key: listAllSnapshots

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Resource Type string	Default	Notes Used to filter snapshots by a resource type

List All Tags#

List All Tags | key: listAllTags

Input	Notes
Input Connection connection / Required	Notes

List All Volume Actions#

List All Actions for a Volume | key: listAllVolumeActions

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Volume Id string / Required	Default	Notes The ID of the block storage volume

List All Volumes#

List All Block Storage Volumes | key: listAllVolumes

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Name string	Default	Notes The block storage volume"s name	Example
Input Page string	Default 1	Notes Which "page" of paginated results to return	Example
Input Per Page string	Default 20	Notes Number of items returned per page	Example
Input Region string	Default	Notes The slug identifier for the region where the resource is available	Example nyc3

List Apps#

List All Apps | key: listApps

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Billing History#

List Billing History | key: listBillingHistory

Input	Notes
Input Connection connection / Required	Notes

List Cdn Endpoints#

List All CDN Endpoints | key: listCdnEndpoints

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Certificates#

List All Certificates | key: listCertificates

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Connection Pools#

List Connection Pools (PostgreSQL) | key: listConnectionPools

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Database Backups#

List Backups for a Database Cluster | key: listDatabaseBackups

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Database Clusters#

List All Database Clusters | key: listDatabaseClusters

Input	Notes
Input Connection connection / Required	Notes
Input Tag Name string	Notes Limits the results to database clusters with a specific tag

List Database Firewalls#

List Firewall Rules (Trusted Sources) for a Database Cluster | key: listDatabaseFirewalls

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Databases#

List All Databases | key: listDatabases

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Default Project Resources#

List Default Project Resources | key: listDefaultProjectResources

Input	Notes
Input Connection connection / Required	Notes

List Deployments#

List App Deployments | key: listDeployments

Input	Default	Notes
Input App Id string / Required	Default	Notes The app ID
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Droplet Actions#

List Actions for a Droplet | key: listDropletActions

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Droplet Id string / Required	Default	Notes A unique identifier for a Droplet instance
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Droplet Associated Resources#

List Associated Resources for a Droplet | key: listDropletAssociatedResources

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

List Droplet Backups#

List Backups for a Droplet | key: listDropletBackups

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Droplet Id string / Required	Default	Notes A unique identifier for a Droplet instance
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Droplet Firewalls#

List all Firewalls Applied to a Droplet | key: listDropletFirewalls

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Droplet Id string / Required	Default	Notes A unique identifier for a Droplet instance
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Droplet Kernels#

List All Available Kernels for a Droplet | key: listDropletKernels

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Droplet Id string / Required	Default	Notes A unique identifier for a Droplet instance
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Droplet Neighbors#

List Neighbors for a Droplet | key: listDropletNeighbors

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

List Droplet Snapshots#

List Snapshots for a Droplet | key: listDropletSnapshots

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Droplet Id string / Required	Default	Notes A unique identifier for a Droplet instance
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Firewalls#

List All Firewalls | key: listFirewalls

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

List Floating Ip Actions#

List All Actions for a Floating IP | key: listFloatingIpActions

Input	Notes
Input Connection connection / Required	Notes
Input Floating Ip string / Required	Notes A floating IP address

List Floating Ips#

List All Floating IPs | key: listFloatingIps

Input	Notes
Input Connection connection / Required	Notes

List Garbage Collections#

List Garbage Collections | key: listGarbageCollections

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Registry Name string / Required	Default	Notes The name of a container registry

List Image Actions#

List All Actions for an Image | key: listImageActions

Input	Notes
Input Connection connection / Required	Notes
Input Image Id string / Required	Notes A unique number that can be used to identify and reference a specific image

List Instance Sizes#

List Instance Sizes | key: listInstanceSizes

Input	Notes
Input Connection connection / Required	Notes

List Invoices#

List All Invoices | key: listInvoices

Input	Notes
Input Connection connection / Required	Notes

List Kubernetes Associated Resources#

List Associated Resources for Cluster Deletion | key: listKubernetesAssociatedResources

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

List Kubernetes Options#

List Available Regions, Node Sizes, and Versions of Kubernetes | key: listKubernetesOptions

Input	Notes
Input Connection connection / Required	Notes

List Node Pools#

List All Node Pools in a Kubernetes Clusters | key: listNodePools

Input	Notes
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster
Input Connection connection / Required	Notes

List Project Resources#

List Project Resources | key: listProjectResources

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes A unique identifier for a project

List Projects#

List All Projects | key: listProjects

Input	Notes
Input Connection connection / Required	Notes

List Regions#

List App Regions | key: listRegions

Input	Notes
Input Connection connection / Required	Notes

List Registry Repositories#

List All Container Registry Repositories | key: listRegistryRepositories

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Registry Name string / Required	Default	Notes The name of a container registry

List Registry Repositories V 2#

List All Container Registry Repositories (V2) | key: listRegistryRepositoriesV2

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Page Token string	Default	Notes Token to retrieve of the next or previous set of results more quickly than using "page"
Input Per Page string	Default 20	Notes Number of items returned per page
Input Registry Name string / Required	Default	Notes The name of a container registry

List Replicas#

List All Read-only Replicas | key: listReplicas

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Repository Digests#

List All Container Registry Repository Manifests | key: listRepositoryDigests

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Registry Name string / Required	Default	Notes The name of a container registry
Input Repository Name string / Required	Default	Notes The name of a container registry repository

List Repository Tags#

List All Container Registry Repository Tags | key: listRepositoryTags

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Registry Name string / Required	Default	Notes The name of a container registry
Input Repository Name string / Required	Default	Notes The name of a container registry repository

List Tiers#

List App Tiers | key: listTiers

Input	Notes
Input Connection connection / Required	Notes

List Users#

List all Database Users | key: listUsers

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

List Volume Snapshots#

List Snapshots for a Volume | key: listVolumeSnapshots

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Volume Id string / Required	Default	Notes The ID of the block storage volume

List Vpc Members#

List the Member Resources of a VPC | key: listVpcMembers

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Resource Type string	Default	Notes Used to filter VPC members by a resource type
Input Vpc Id string / Required	Default	Notes A unique identifier for a VPC

List Vpcs#

List All VPCs | key: listVpcs

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

Patch Database Config#

Update the Database Configuration for an Existing Database | key: patchDatabaseConfig

Input	Notes
Input Config string	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster

Patch Default Project#

Patch the Default Project | key: patchDefaultProject

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Created At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the project was created	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)
Input Description string	Default	Notes The description of the project	Example My website API
Input Environment string	Default	Notes The environment of the project"s resources	Example Production
Input Id string	Default	Notes The unique universal identifier of this project	Example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679
Input Is Default boolean	Default false	Notes If true, all resources will be added to this project if no project is specified	Example false
Input Name string	Default	Notes The human-readable name for the project	Example my-web-api
Input Owner Id string	Default	Notes The integer id of the project owner	Example 258992
Input Owner Uuid string	Default	Notes The unique universal identifier of the project owner	Example 99525febec065ca37b2ffe4f852fd2b2581895e7
Input Purpose string	Default	Notes The purpose of the project	Example Service or API
Input Updated At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the project was updated	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)

Patch Project#

Patch a Project | key: patchProject

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Created At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the project was created	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)
Input Description string	Default	Notes The description of the project	Example My website API
Input Environment string	Default	Notes The environment of the project"s resources	Example Production
Input Id string	Default	Notes The unique universal identifier of this project	Example 4e1bfbc3-dc3e-41f2-a18f-1b4d7ba71679
Input Is Default boolean	Default false	Notes If true, all resources will be added to this project if no project is specified	Example false
Input Name string	Default	Notes The human-readable name for the project	Example my-web-api
Input Owner Id string	Default	Notes The integer id of the project owner	Example 258992
Input Owner Uuid string	Default	Notes The unique universal identifier of the project owner	Example 99525febec065ca37b2ffe4f852fd2b2581895e7
Input Project Id string / Required	Default	Notes A unique identifier for a project	Example
Input Purpose string	Default	Notes The purpose of the project	Example Service or API
Input Updated At string	Default	Notes A time value given in ISO8601 combined date and time format that represents when the project was updated	Example Thu Sep 27 2018 13:10:35 GMT-0700 (Mountain Standard Time)

Patch Update Domain Record#

Update a Domain Record | key: patchUpdateDomainRecord

Input	Notes	Example
Input Data string	Notes Variable data depending on record type	Example ns1.digitalocean.com
Input Connection connection / Required	Notes	Example
Input Domain Name string / Required	Notes The name of the domain itself	Example
Input Domain Record Id string / Required	Notes The unique identifier of the domain record	Example
Input Flags string	Notes An unsigned integer between 0-255 used for CAA records	Example null
Input Id string	Notes A unique identifier for each domain record	Example 28448429
Input Name string	Notes The host name, alias, or service being defined by the record	Example @
Input Port string	Notes The port for SRV records	Example null
Input Priority string	Notes The priority for SRV and MX records	Example null
Input Tag string	Notes The parameter tag for CAA records	Example null
Input Ttl string	Notes This value is the time to live for the record, in seconds	Example 1800
Input Type string / Required	Notes The type of the DNS record	Example NS
Input Weight string	Notes The weight for SRV records	Example null

Patch Vpc#

Partially Update a VPC | key: patchVpc

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Default boolean	Default false	Notes A boolean value indicating whether or not the VPC is the default network for the region	Example true
Input Description string	Default	Notes A free-form text field for describing the VPC"s purpose	Example VPC for production environment
Input Name string	Default	Notes The name of the VPC	Example env.prod-vpc
Input Vpc Id string / Required	Default	Notes A unique identifier for a VPC	Example

Post Cancel Deployment#

Cancel a Deployment | key: postCancelDeployment

Input	Notes
Input App Id string / Required	Notes The app ID
Input Connection connection / Required	Notes
Input Deployment Id string / Required	Notes The deployment ID

Post Droplet Action#

Initiate a Droplet Action | key: postDropletAction

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Post Droplet Action By Tag#

Acting on Tagged Droplets | key: postDropletActionByTag

Input	Notes
Input Connection connection / Required	Notes
Input Tag Name string	Notes Used to filter Droplets by a specific tag

Post Floating Ip Action#

Initiate a Floating IP Action | key: postFloatingIpAction

Input	Notes
Input Connection connection / Required	Notes
Input Floating Ip string / Required	Notes A floating IP address

Post Image Action#

Initiate an Image Action | key: postImageAction

Input	Notes
Input Connection connection / Required	Notes
Input Image Id string / Required	Notes A unique number that can be used to identify and reference a specific image

Post Registry Subscription#

Update Subscription Tier | key: postRegistrySubscription

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Tier Slug string	Notes The slug of the subscription tier to sign up for	Example basic

Post Volume Action By Id#

Initiate A Block Storage Action By Volume Id | key: postVolumeActionById

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page
Input Volume Id string / Required	Default	Notes The ID of the block storage volume

Post Volume Action By Name#

Initiate A Block Storage Action By Volume Name | key: postVolumeActionByName

Input	Default	Notes
Input Connection connection / Required	Default	Notes
Input Page string	Default 1	Notes Which "page" of paginated results to return
Input Per Page string	Default 20	Notes Number of items returned per page

Purge Cdn Cache#

Purge the Cache for an Existing CDN Endpoint | key: purgeCdnCache

Input	Notes	Example
Input Cdn Id string / Required	Notes A unique identifier for a CDN endpoint	Example
Input Connection connection / Required	Notes	Example
Input Files string / Required	Notes An array of strings containing the path to the content to be purged from the CDN cache	Example path/to/image.png,path/to/css/*

Raw Request#

Issue a raw HTTP request | key: rawRequest

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Data string	Default	Notes The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.	Example {"exampleKey": "Example Data"}
Input Debug Request boolean	Default false	Notes Enabling this flag will log out the current request.	Example
Input File Data string Key Value List	Default	Notes File Data to be sent as a multipart form upload.	Example [{key: "example.txt", value: "My File Contents"}]
Input Form Data string Key Value List	Default	Notes The Form Data to be sent as a multipart form upload.	Example [{"key": "Example Key", "value": new Buffer("Hello World")}]
Input Header string Key Value List	Default	Notes A list of headers to send with the request.	Example User-Agent: curl/7.64.1
Input Max Retry Count string	Default 0	Notes The maximum number of retries to attempt.	Example
Input Method string / Required	Default	Notes The HTTP method to use.	Example
Input Query Parameter string Key Value List	Default	Notes A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.	Example
Input Response Type string / Required	Default json	Notes The type of data you expect in the response. You can request json, text, or binary data.	Example
Input Retry On All Errors boolean	Default false	Notes If true, retries on all erroneous responses regardless of type.	Example
Input Retry Delay (ms) string	Default 0	Notes The delay in milliseconds between retries.	Example
Input Timeout string	Default	Notes The maximum time that a client will await a response to its request	Example 2000
Input URL string / Required	Default	Notes This is the URL to call.	Example /sobjects/Account
Input Use Exponential Backoff boolean	Default false	Notes Specifies whether to use a pre-defined exponential backoff strategy for retries.	Example

Recycle Kubernetes Node Pool#

Recycle a Kubernetes Node Pool | key: recycleKubernetesNodePool

Input	Notes	Example
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Notes	Example
Input Node Pool Id string / Required	Notes A unique ID that can be used to reference a Kubernetes node pool	Example
Input Nodes string	Notes	Example d8db5e1a-6103-43b5-a7b3-8a948210a9fc

Remove Load Balancer Droplets#

Remove Droplets from a Load Balancer | key: removeLoadBalancerDroplets

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Droplet Ids string / Required	Notes An array containing the IDs of the Droplets assigned to the load balancer	Example 3164444,3164445
Input Lb Id string / Required	Notes A unique identifier for a load balancer	Example

Remove Load Balancer Forwarding Rules#

Remove Forwarding Rules from a Load Balancer | key: removeLoadBalancerForwardingRules

Input	Notes
Input Connection connection / Required	Notes
Input Forwarding Rules string / Required	Notes
Input Lb Id string / Required	Notes A unique identifier for a load balancer

Remove Registry#

Remove Container Registry from Kubernetes Clusters | key: removeRegistry

Input	Notes	Example
Input Cluster Uuids string	Notes An array containing the UUIDs of Kubernetes clusters	Example bd5f5959-5e1e-4205-a714-a914373942af,50c2f44c-011d-493e-aee5-361a4a0d1844
Input Connection connection / Required	Notes	Example

Reset Auth#

Reset a Database User"s Password or Authentication Method | key: resetAuth

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Mysql Settings string	Notes
Input Username string / Required	Notes The name of the database user

Retry Destroy With Associated Resource#

Retry a Droplet Destroy with Associated Resources Request | key: retryDestroyWithAssociatedResource

Input	Notes
Input Connection connection / Required	Notes
Input Droplet Id string / Required	Notes A unique identifier for a Droplet instance

Run Clusterlint#

Run Clusterlint Checks on a Kubernetes Cluster | key: runClusterlint

Input	Notes	Example
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Notes	Example
Input Exclude Checks string	Notes An array of checks that will be run when clusterlint executes checks	Example default-namespace
Input Exclude Groups string	Notes An array of check groups that will be omitted when clusterlint executes checks	Example workload-health
Input Include Checks string	Notes An array of checks that will be run when clusterlint executes checks	Example bare-pods,resource-requirements
Input Include Groups string	Notes An array of check groups that will be run when clusterlint executes checks	Example basic,doks,security

Run Commit App Rollback#

Commit App Rollback | key: runCommitAppRollback

Input	Notes
Input App Id string / Required	Notes The app ID
Input Connection connection / Required	Notes

Run Garbage Collection#

Start Garbage Collection | key: runGarbageCollection

Input	Notes
Input Connection connection / Required	Notes
Input Registry Name string / Required	Notes The name of a container registry

Run Revert App Rollback#

Revert App Rollback | key: runRevertAppRollback

Input	Notes
Input App Id string / Required	Notes The app ID
Input Connection connection / Required	Notes

Tag Resource#

Tag a Resource | key: tagResource

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Resources string / Required	Notes An array of objects containing resource_id and resource_type attributes	Example [object Object],[object Object],[object Object]
Input Tag Id string / Required	Notes The name of the tag	Example

Untag Resource#

Untag a Resource | key: untagResource

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Resources string / Required	Notes An array of objects containing resource_id and resource_type attributes	Example [object Object],[object Object],[object Object]
Input Tag Id string / Required	Notes The name of the tag	Example

Update Alert Policy#

Update an Alert Policy | key: updateAlertPolicy

Input	Default	Notes	Example
Input Alerts string / Required	Default	Notes	Example
Input Alert Uuid string / Required	Default	Notes A unique identifier for an alert policy	Example
Input Compare string / Required	Default	Notes	Example GreaterThan
Input Connection connection / Required	Default	Notes	Example
Input Description string / Required	Default	Notes	Example CPU Alert
Input Enabled boolean / Required	Default false	Notes	Example true
Input Entities string / Required	Default	Notes	Example 192018292
Input Tags string / Required	Default	Notes	Example droplet_tag
Input Type string / Required	Default	Notes	Example v1/insights/droplet/cpu
Input Value string / Required	Default	Notes	Example 80
Input Window string / Required	Default	Notes	Example 5m

Update App#

Update an App | key: updateApp

Input	Notes
Input Connection connection / Required	Notes
Input Id string / Required	Notes The ID of the app
Input Spec string / Required	Notes The desired configuration of an application

Update Cdn Endpoint#

Update a CDN Endpoint | key: updateCdnEndpoint

Input	Default	Notes	Example
Input Cdn Id string / Required	Default	Notes A unique identifier for a CDN endpoint	Example
Input Certificate Id string	Default	Notes The ID of a DigitalOcean managed TLS certificate used for SSL when a custom subdomain is provided	Example 892071a0-bb95-49bc-8021-3afd67a210bf
Input Connection connection / Required	Default	Notes	Example
Input Custom Domain string	Default	Notes The fully qualified domain name (FQDN) of the custom subdomain used with the CDN endpoint	Example static.example.com
Input Ttl string	Default 3600	Notes The amount of time the content is cached by the CDN"s edge servers in seconds	Example 3600

Update Database Cluster#

Migrate a Database Cluster to a New Region | key: updateDatabaseCluster

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Region string / Required	Notes A slug identifier for the region to which the database cluster will be migrated	Example lon1

Update Database Cluster Size#

Resize a Database Cluster | key: updateDatabaseClusterSize

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Num Nodes string / Required	Notes The number of nodes in the database cluster	Example 3
Input Size string / Required	Notes A slug identifier representing desired the size of the nodes in the database cluster	Example db-s-4vcpu-8gb

Update Database Firewall#

Update Firewall Rules (Trusted Sources) for a Database | key: updateDatabaseFirewall

Input	Notes
Input Connection connection / Required	Notes
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster
Input Rules string	Notes

Update Default Project#

Update the Default Project | key: updateDefaultProject

Input	Notes
Input Connection connection / Required	Notes

Update Domain Record#

Update a Domain Record | key: updateDomainRecord

Input	Notes	Example
Input Data string	Notes Variable data depending on record type	Example ns1.digitalocean.com
Input Connection connection / Required	Notes	Example
Input Domain Name string / Required	Notes The name of the domain itself	Example
Input Domain Record Id string / Required	Notes The unique identifier of the domain record	Example
Input Flags string	Notes An unsigned integer between 0-255 used for CAA records	Example null
Input Id string	Notes A unique identifier for each domain record	Example 28448429
Input Name string	Notes The host name, alias, or service being defined by the record	Example @
Input Port string	Notes The port for SRV records	Example null
Input Priority string	Notes The priority for SRV and MX records	Example null
Input Tag string	Notes The parameter tag for CAA records	Example null
Input Ttl string	Notes This value is the time to live for the record, in seconds	Example 1800
Input Type string / Required	Notes The type of the DNS record	Example NS
Input Weight string	Notes The weight for SRV records	Example null

Update Eviction Policy#

Configure the Eviction Policy for a Redis Cluster | key: updateEvictionPolicy

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Eviction Policy string / Required	Notes A string specifying the desired eviction policy for the Redis cluster	Example noeviction

Update Firewall#

Update a Firewall | key: updateFirewall

Input	Notes
Input Connection connection / Required	Notes
Input Firewall Id string / Required	Notes A unique ID that can be used to identify and reference a firewall

Update Garbage Collection#

Update Garbage Collection | key: updateGarbageCollection

Input	Default	Notes	Example
Input Cancel boolean	Default false	Notes A boolean value indicating that the garbage collection should be cancelled	Example true
Input Connection connection / Required	Default	Notes	Example
Input Garbage Collection Uuid string / Required	Default	Notes The UUID of a garbage collection run	Example
Input Registry Name string / Required	Default	Notes The name of a container registry	Example

Update Image#

Update an Image | key: updateImage

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Description string	Notes An optional free-form text field to describe an image	Example
Input Distribution string	Notes The name of a custom image"s distribution	Example Ubuntu
Input Image Id string / Required	Notes A unique number that can be used to identify and reference a specific image	Example
Input Name string	Notes The display name that has been given to an image	Example Nifty New Snapshot

Update Kubernetes Cluster#

Update a Kubernetes Cluster | key: updateKubernetesCluster

Input	Default	Notes	Example
Input Auto Upgrade boolean	Default false	Notes A boolean value indicating whether the cluster will be automatically upgraded to new patch releases during its maintenance window	Example true
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Default	Notes	Example
Input Maintenance Policy string	Default	Notes An object specifying the maintenance window policy for the Kubernetes cluster	Example
Input Name string / Required	Default	Notes A human-readable name for a Kubernetes cluster	Example prod-cluster-01
Input Surge Upgrade boolean	Default false	Notes A boolean value indicating whether surge upgrade is enabled/disabled for the cluster	Example true
Input Tags string	Default	Notes An array of tags applied to the Kubernetes cluster	Example k8s,k8s:bd5f5959-5e1e-4205-a714-a914373942af,production,web-team

Update Kubernetes Node Pool#

Update a Node Pool in a Kubernetes Cluster | key: updateKubernetesNodePool

Input	Default	Notes	Example
Input Auto Scale boolean	Default false	Notes A boolean value indicating whether auto-scaling is enabled for this node pool	Example true
Input Cluster Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Default	Notes	Example
Input Count string / Required	Default	Notes The number of Droplet instances in the node pool	Example 3
Input Id string	Default	Notes A unique ID that can be used to identify and reference a specific node pool	Example cdda885e-7663-40c8-bc74-3a036c66545d
Input Labels string	Default	Notes An object containing a set of Kubernetes labels	Example null
Input Max Nodes string	Default	Notes The maximum number of nodes that this node pool can be auto-scaled to	Example 6
Input Min Nodes string	Default	Notes The minimum number of nodes that this node pool can be auto-scaled to	Example 3
Input Name string / Required	Default	Notes A human-readable name for the node pool	Example frontend-pool
Input Node Pool Id string / Required	Default	Notes A unique ID that can be used to reference a Kubernetes node pool	Example
Input Nodes string	Default	Notes An object specifying the details of a specific worker node in a node pool	Example
Input Tags string	Default	Notes An array containing the tags applied to the node pool	Example k8s,k8s:bd5f5959-5e1e-4205-a714-a914373942af,k8s-worker,production,web-team
Input Taints string	Default	Notes An array of taints to apply to all nodes in a pool	Example

Update Load Balancer#

Update a Load Balancer | key: updateLoadBalancer

Input	Notes
Input Connection connection / Required	Notes
Input Lb Id string / Required	Notes A unique identifier for a load balancer

Update Maintenance Window#

Configure a Database Cluster"s Maintenance Window | key: updateMaintenanceWindow

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Database Cluster Uuid string / Required	Default	Notes A unique identifier for a database cluster	Example
Input Day string / Required	Default	Notes The day of the week on which to apply maintenance updates	Example tuesday
Input Description string	Default	Notes A list of strings, each containing information about a pending maintenance update	Example Update TimescaleDB to version 1.2.1,Upgrade to PostgreSQL 11.2 and 10.7 bugfix releases
Input Hour string / Required	Default	Notes The hour in UTC at which maintenance updates will be applied in 24 hour format	Example 14:00
Input Pending boolean	Default false	Notes A boolean value indicating whether any maintenance is scheduled to be performed in the next window	Example true

Update Online Migration#

Start an Online Migration | key: updateOnlineMigration

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Database Cluster Uuid string / Required	Default	Notes A unique identifier for a database cluster	Example
Input Disable Ssl boolean	Default false	Notes Enables SSL encryption when connecting to the source database	Example false
Input Source string	Default	Notes	Example

Update Project#

Update a Project | key: updateProject

Input	Notes
Input Connection connection / Required	Notes
Input Project Id string / Required	Notes A unique identifier for a project

Update Sql Mode#

Update SQL Mode for a Cluster | key: updateSqlMode

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Database Cluster Uuid string / Required	Notes A unique identifier for a database cluster	Example
Input Sql Mode string / Required	Notes A string specifying the configured SQL modes for the MySQL cluster	Example ANSI,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,STRICT_ALL_TABLES

Update Ssh Key#

Update an SSH Key"s Name | key: updateSshKey

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string	Notes A human-readable display name for this key, used to easily identify the SSH keys when they are displayed	Example My SSH Public Key
Input Ssh Key Identifier string / Required	Notes Either the ID or the fingerprint of an existing SSH key	Example

Update Vpc#

Update a VPC | key: updateVpc

Input	Default	Notes	Example
Input Connection connection / Required	Default	Notes	Example
Input Default boolean	Default false	Notes A boolean value indicating whether or not the VPC is the default network for the region	Example true
Input Description string	Default	Notes A free-form text field for describing the VPC"s purpose	Example VPC for production environment
Input Name string / Required	Default	Notes The name of the VPC	Example env.prod-vpc
Input Vpc Id string / Required	Default	Notes A unique identifier for a VPC	Example

Upgrade Kubernetes Cluster#

Upgrade a Kubernetes Cluster | key: upgradeKubernetesCluster

Input	Notes	Example
Input Cluster Id string / Required	Notes A unique ID that can be used to reference a Kubernetes cluster	Example
Input Connection connection / Required	Notes	Example
Input Version string	Notes The slug identifier for the version of Kubernetes that the cluster will be upgraded to	Example 1.16.13-do.0

Validate App Rollback#

Validate App Rollback | key: validateAppRollback

Input	Default	Notes	Example
Input App Id string / Required	Default	Notes The app ID	Example
Input Connection connection / Required	Default	Notes	Example
Input Deployment Id string	Default	Notes The ID of the deployment to rollback to	Example 3aa4d20e-5527-4c00-b496-601fbd22520a
Input Skip Pin boolean	Default false	Notes Whether to skip pinning the rollback deployment	Example false

Validate App Spec#

Propose an App Spec | key: validateAppSpec

Input	Notes	Example
Input App Id string	Notes An optional ID of an existing app	Example b6bdf840-2854-4f87-a36c-5f231c617c84
Input Connection connection / Required	Notes	Example
Input Spec string / Required	Notes The desired configuration of an application	Example

Validate Registry Name#

Validate a Container Registry Name | key: validateRegistryName

Input	Notes	Example
Input Connection connection / Required	Notes	Example
Input Name string / Required	Notes A globally unique name for the container registry	Example example

Description
DigitalOcean Connections
- OAuth 2.0
Actions