DigitalOcean Compute Driver Documentation

DigitalOcean is an American cloud provider based in New York City with data centers in New York, Amsterdam, San Francisco, London, Singapore, Frankfurt, Toronto, and Bangalore.


Instantiating a driver

The DigitalOcean driver supports API v2.0, requiring a Personal Access Token to initialize as the key. The older API v1.0 reached end of life on November 9, 2015. Support for API v1.0 was removed in libcloud v1.2.2.

Instantiating a driver using API v2.0

from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver

cls = get_driver(Provider.DIGITAL_OCEAN)

driver = cls('access token', api_version='v2')

Creating a Droplet using API v2.0

from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver

cls = get_driver(Provider.DIGITAL_OCEAN)

driver = cls('access token', api_version='v2')

options = {'backups': True,
           'private_networking': True,
           'ssh_keys': [123456, 123457]}

name = 'test.domain.tld'
size = driver.list_sizes()[0]
image = driver.list_images()[0]
location = driver.list_locations()[0]

node = driver.create_node(name, size, image, location,

API Docs

API v2.0

class libcloud.compute.drivers.digitalocean.DigitalOcean_v2_NodeDriver(key, secret=None, secure=True, host=None, port=None, api_version=None, region=None, ex_per_page=200, **kwargs)[source]

DigitalOcean NodeDriver using v2 of the API.

attach_volume(node, volume, device=None)[source]

Attaches volume to node.

  • node (Node) – Node to attach volume to.
  • volume (StorageVolume) – Volume to attach.
  • device (str) – Where the device is exposed, e.g. ‘/dev/sdb’



alias of DigitalOcean_v2_Connection

copy_image(source_region, node_image, name, description=None)

Copies an image from a source region to the current region.

  • source_region (str) – Region to copy the node from.
  • node_image (NodeImage:) – NodeImage to copy.
  • name (str) – name for new image.
  • description – description for new image.
Return type:



NodeImage instance on success.

create_image(node, name)[source]

Create an image from a Node.

@inherits: NodeDriver.create_image

  • node (str) – Node to use as base for image
  • node – Name for image
Return type:


create_key_pair(name, public_key='')[source]

Create a new SSH key.

  • name (str) – Key name (required)
  • public_key (str) – Valid public key string (required)
create_node(name, size, image, location, ex_create_attr=None, ex_ssh_key_ids=None, ex_user_data=None)[source]

Create a node.

The ex_create_attr parameter can include the following dictionary key and value pairs:

  • backups: bool defaults to False
  • ipv6: bool defaults to False
  • private_networking: bool defaults to False
  • user_data: str for cloud-config data
  • ssh_keys: list of int key ids or str fingerprints

ex_create_attr[‘ssh_keys’] will override ex_ssh_key_ids assignment.

  • ex_create_attr (dict) – A dictionary of optional attributes for droplet creation
  • ex_ssh_key_ids (list of int key ids or str key fingerprints) – A list of ssh key ids which will be added to the server. (optional)
  • ex_user_data (str) – User data to be added to the node on create. (optional)

The newly created node.

Return type:


create_volume(size, name, location=None, snapshot=None)[source]

Create a new volume.

  • size (int) – Size of volume in gigabytes (required)
  • name (str) – Name of the volume to be created
  • location (NodeLocation) – Which data center to create a volume in. If empty, undefined behavior will be selected. (optional)
  • snapshot (VolumeSnapshot) – Snapshot from which to create the new volume. (optional)

The newly created volume.

Return type:


create_volume_snapshot(volume, name)[source]

Create a new volume snapshot.

Parameters:volume (class:StorageVolume) – Volume to create a snapshot for
Returns:The newly created volume snapshot.
Return type:VolumeSnapshot

Delete an image for node.

@inherits: NodeDriver.delete_image

Parameters:image (NodeImage) – the image to be deleted
Return type:bool

Delete an existing SSH key.

Parameters:key (KeyPair) – SSH key (required)

Delete a volume snapshot

Parameters:snapshot (class:VolumeSnapshot) – volume snapshot to delete
Return type:bool

Create a new node, and start deployment.

In order to be able to SSH into a created node access credentials are required.

A user can pass either a NodeAuthPassword or NodeAuthSSHKey to the auth argument. If the create_node implementation supports that kind if credential (as declared in self.features['create_node']) then it is passed on to create_node. Otherwise it is not passed on to create_node and it is only used for authentication.

If the auth parameter is not supplied but the driver declares it supports generates_password then the password returned by create_node will be used to SSH into the server.

Finally, if the ssh_key_file is supplied that key will be used to SSH into the server.

This function may raise a DeploymentException, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable.

>>> from libcloud.compute.drivers.dummy import DummyNodeDriver
>>> from libcloud.compute.deployment import ScriptDeployment
>>> from libcloud.compute.deployment import MultiStepDeployment
>>> from libcloud.compute.base import NodeAuthSSHKey
>>> driver = DummyNodeDriver(0)
>>> key = NodeAuthSSHKey('...') # read from file
>>> script = ScriptDeployment("yum -y install emacs strace tcpdump")
>>> msd = MultiStepDeployment([key, script])
>>> def d():
...     try:
...         driver.deploy_node(deploy=msd)
...     except NotImplementedError:
...         print ("not implemented for dummy driver")
>>> d()
not implemented for dummy driver

Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such.

  • deploy (Deployment) – Deployment to run once machine is online and available to SSH.
  • ssh_username (str) – Optional name of the account which is used when connecting to SSH server (default is root)
  • ssh_alternate_usernames (list) – Optional list of ssh usernames to try to connect with if using the default one fails
  • ssh_port (int) – Optional SSH server port (default is 22)
  • ssh_timeout (float) – Optional SSH connection timeout in seconds (default is 10)
  • auth (NodeAuthSSHKey or NodeAuthPassword) – Initial authentication information for the node (optional)
  • ssh_key (str or list of str) – A path (or paths) to an SSH private key with which to attempt to authenticate. (optional)
  • timeout (int) – How many seconds to wait before timing out. (default is 600)
  • max_tries (int) – How many times to retry if a deployment fails before giving up (default is 3)
  • ssh_interface (str) – The interface to wait for. Default is ‘public_ips’, other option is ‘private_ips’.

Destroys a storage volume.

Parameters:volume (StorageVolume) – Volume to be destroyed
Return type:bool

Destroys a snapshot.

Parameters:snapshot (VolumeSnapshot) – The snapshot to delete
Return type:bool

Detaches a volume from a node.

Parameters:volume (StorageVolume) – Volume to be detached
Return type:bool

Get an event object

Parameters:event_id (str) – Event id (required)

Get an image based on an image_id

@inherits: NodeDriver.get_image

Parameters:image_id (int) – Image identifier
Returns:A NodeImage object
Return type:NodeImage

Retrieve a single key pair.

Parameters:name (str) – Name of the key pair to retrieve.
Return type:KeyPair
import_key_pair_from_file(name, key_file_path)

Import a new public key from string.

  • name (str) – Key pair name.
  • key_file_path (str) – Path to the public key file.
Return type:

KeyPair object

import_key_pair_from_string(name, key_material)

Import a new public key from string.

  • name (str) – Key pair name.
  • key_material (str) – Public key material.
Return type:

KeyPair object


List all the available SSH keys.

Returns:Available SSH keys.
Return type:list of KeyPair

List snapshots for a volume.

Parameters:volume (class:StorageVolume) – Volume to list snapshots for
Returns:List of volume snapshots.
Return type:list of :class: StorageVolume
wait_until_running(nodes, wait_period=3, timeout=600, ssh_interface='public_ips', force_ipv4=True, ex_list_nodes_kwargs=None)

Block until the provided nodes are considered running.

Node is considered running when it’s state is “running” and when it has at least one IP address assigned.

  • nodes (list of Node) – List of nodes to wait for.
  • wait_period (int) – How many seconds to wait between each loop iteration. (default is 3)
  • timeout (int) – How many seconds to wait before giving up. (default is 600)
  • ssh_interface (str) – Which attribute on the node to use to obtain an IP address. Valid options: public_ips, private_ips. Default is public_ips.
  • force_ipv4 (bool) – Ignore IPv6 addresses (default is True).
  • ex_list_nodes_kwargs (dict) – Optional driver-specific keyword arguments which are passed to the list_nodes method.

[(Node, ip_addresses)] list of tuple of Node instance and list of ip_address on success.

Return type:

list of tuple