DigitalOcean API
Base URI
DigitalOcean client id
DigitalOcean API key
{droplet_id}{droplet_id}/reboot{droplet_id}/power_cycle{droplet_id}/shutdown{droplet_id}/power_off{droplet_id}/power_on{droplet_id}/password_reset{droplet_id}/resize{droplet_id}/snapshot{droplet_id}/restore{droplet_id}/rebuild{droplet_id}/rename{droplet_id}/destroyThis method returns all active droplets that are currently running in your account. All available API information is presented for each droplet.
Responses
Body
This method allows you to create a new droplet. See the required parameters section below for an explanation of the variables that are needed to create a new droplet.
Request parameters
this is the name of the droplet - must be formatted by hostname rules
this is the id of the size with which you would like the droplet created
One of size_id or size_slug must be specified
this is the slug of the size with which you would like the droplet created
One of size_id or size_slug must be specified
the id of the image you would like the droplet created with
One of image_id or image_slug must be specified
the slug of the image you would like the droplet created with
One of image_id or image_slug must be specified
this is the id of the region you would like your server in
One of region_id or region_slug must be specified
the slug of the region you would like your server in
One of region_id or region_slug must be specified
Numeric comma separated list of ssh_key_ids that you would like to be added to the server
enables a private network interface if the region supports private networking
enables backups for your droplet
Responses
Body
{droplet_id}This method returns full information for a specific droplet ID that is passed in the URL.
Path variables
this is the id of your droplet
Responses
Body
{droplet_id}/rebootThis method allows you to reboot a droplet. This is the preferred method to use if a server is not responding.
Path variables
the id of your droplet that you want to reboot
Responses
Body
{droplet_id}/power_cycleThis method allows you to power cycle a droplet. This will turn off the droplet and then turn it back on.
Path variables
this is the id of your droplet that you want to power cycle
Responses
Body
{droplet_id}/shutdownPath variables
droplet id
Responses
Body
{droplet_id}/power_offThis method allows you to poweroff a running droplet. The droplet will remain in your account.
Path variables
this is the id of your droplet that you want to power off
Responses
Body
{droplet_id}/power_onThis method allows you to poweron a powered off droplet.
Path variables
droplet_id
Responses
Body
{droplet_id}/password_resetThis method will reset the root password for a droplet. Please be aware that this will reboot the droplet to allow resetting the password
Path variables
the id of your droplet that you want to reset password on
Responses
Body
{droplet_id}/resizeThis method allows you to resize a specific droplet to a different size. This will affect the number of processors and memory allocated to the droplet.
Path variables
the id of your droplet that you want to resize
Request parameters
this is the id of the size with which you would like the droplet created
One of size_id or size_slug must be specified
this is the slug of the size with which you would like the droplet created
One of size_id or size_slug must be specified
Responses
Body
{droplet_id}/snapshotThis method allows you to take a snapshot of the droplet once it has been powered off, which can later be restored or used to create a new droplet from the same image. Please be aware this may cause a reboot.
Path variables
the id of your droplet that you want to resize
Request parameters
the name of the new snapshot you want to create. If not set, the snapshot name will default to date/time
Responses
Body
{droplet_id}/restoreThis method allows you to restore a droplet with a previous image or snapshot. This will be a mirror copy of the image or snapshot to your droplet. Be sure you have backed up any necessary information prior to restore.
Path variables
the id of your droplet that you want to restore
Request parameters
this is the id of the image you would like to use to restore your droplet with
Responses
Body
{droplet_id}/rebuildThis method allows you to reinstall a droplet with a default image. This is useful if you want to start again but retain the same IP address for your droplet.
Path variables
the id of your droplet that you want to rebuild
Request parameters
this is the id of the image you would like to use to restore your droplet with
Responses
Body
{droplet_id}/renameThis method renames the droplet to the specified name.
Path variables
the id of your droplet that you want to resize
Request parameters
new name of the droplet
Responses
Body
{droplet_id}/destroyThis method destroys one of your droplets - this is irreversible.
Path variables
the id of your droplet that you want to resize
Request parameters
this will strictly write 0s to your prior partition to ensure that all data is completely erased.
Responses
Body
This method will return all the available regions within the DigitalOcean cloud.
Responses
Body
{image_id_or_slug}{image_id_or_slug}/destroy{image_id_or_slug}/transferThis method returns all the available images that can be accessed by your client ID. You will have access to all public images by default, and any snapshots or backups that you have created in your own account.
Request parameters
either my_images or global
Responses
Body
{image_id_or_slug}This method displays the attributes of an image.
Path variables
the id of the image you would like to use to rebuild your droplet with
Responses
Body
{image_id_or_slug}/destroyThis method allows you to destroy an image. There is no way to restore a deleted image so be careful and ensure your data is properly backed up.
Path variables
this is the id of the image you would like to destroy
Responses
Body
{image_id_or_slug}/transferThis method allows you to transfer an image to a specified region.
Path variables
this is the id of the image you would like to transfer
Responses
Body
{ssh_key_id}{ssh_key_id}/edit{ssh_key_id}/destroyThis method lists all the available public SSH keys in your account that can be added to a droplet.
Responses
Body
This method allows you to add a new public SSH key to your account.
Request parameters
the name you want to give this SSH key.
the actual public SSH key
Responses
Body
{ssh_key_id}This method shows a specific public SSH key in your account that can be added to a droplet.
Path variables
Responses
Body
{ssh_key_id}/editPath variables
This method allows you to modify an existing public SSH key in your account.
Request parameters
the new public SSH key.
Responses
Body
{domain_id}{domain_id}/destroy{domain_id}/records{domain_id}/records/new{domain_id}/records/{record_id}{domain_id}/records/{record_id}{domain_id}/records/{record_id}/destroyThis method returns all of your current domains.
Responses
Body
This method creates a new domain name with an A record for the specified [ip_address].
Request parameters
name of the domain
ip address for the domain`s initial a record.
Responses
Body
{domain_id}This method returns the specified domain.
Path variables
Domain Name (e.g. domain.com), specifies the domain to display.
Responses
Body
{domain_id}/destroyThis method deletes the specified domain.
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain to destroy.
Responses
Body
{domain_id}/recordsThis method returns all of your current domain records.
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain for which to retrieve records.
Responses
Body
{domain_id}/records/new//TODO error in original doc - This method creates a new domain name with an A record for the specified [ip_address].
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain for which to create a record.
Request parameters
the type of record you would like to create. ‘A’, ‘CNAME’, ‘NS’, ‘TXT’, ‘MX’ or ‘SRV’
this is the value of the record
required for ‘A’, ‘CNAME’, ‘TXT’ and ‘SRV’ records
required for ‘SRV’ and ‘MX’ records
required for ‘SRV’ records
required for ‘SRV’ records
Responses
Body
{domain_id}/records/{record_id}This method edits an existing domain record.
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain for which to create a record.
Integer, specifies the record to update.
Request parameters
the type of record you would like to create. ‘A’, ‘CNAME’, ‘NS’, ‘TXT’, ‘MX’ or ‘SRV’
this is the value of the record
required for ‘A’, ‘CNAME’, ‘TXT’ and ‘SRV’ records
required for ‘SRV’ and ‘MX’ records
required for ‘SRV’ records
required for ‘SRV’ records
Responses
Body
{domain_id}/records/{record_id}This method returns the specified domain record.
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain for which to retrieve a record
Integer, specifies the record_id to retrieve
Responses
Body
{domain_id}/records/{record_id}/destroyThis method edits an existing domain record.
Path variables
Integer or Domain Name (e.g. domain.com), specifies the domain for which to create a record.
Integer, specifies the record to update.
Responses
Body
{event_id}{event_id}This method is primarily used to report on the progress of an event by providing the percentage of completion.
Path variables
this is the id of the event you would like more information about.
Responses
Body
Mini version of droplet object
Async request event id