doapi

doapi

The doapi module allows you to communicate with the DigitalOcean API V2 from node.js in a promise friendly manner.

It also supports automatic request retries.

Installation

This module is published in NPM:

npm install doapi --save

The --save tells NPM to automatically add it to your package.json file

Usage

// Import a module
var DigitalOceanAPI = require('doapi');

// Create an instance with your API V2 credentials
var api = new DigitalOceanAPI({token: 'my_token'});

// Get things done
api.dropletGetAll().then(function (droplets) {
	console.log(droplets);
});

Config

new DigitalOceanAPI({
	token: 'my_token',
	itemsPerPage: 100, // default=100
	maxRetries: 5, // default=5
	raw: false // default=false
});

Pagination

you can pass pagination params into any method that has a body or query argument.

api.dropletGetAll({per_page: 1, page: 2}).then(function (droplets) {
	console.log(droplets);
});

Raw

if you set raw it will return the full response body with request info and ratelimiting details, the default is false.

api.accountGet(true)

would return

	{
		account: {
			droplet_limit: 25,
			email: '[e-mail]',
			uuid: 'f5bbaffce3a8792421593a7075b486bafd66672f',
			email_verified: true
		},
		ratelimit: {
			limit: '5000',
			remaining: '4993',
			reset: '1434197547'
		},
		requestinfo: {
			id: 'a24427fd-0d43-9536-a206-zac22d2696e1',
			runtime: '0.038537'
		 }
	}

and with raw set to false (the default), it would return

	{
		droplet_limit: 25,
		email: '[e-mail]',
		uuid: 'f5bbaffce3a8792421593a7075b486bafd66672f',
		email_verified: true
	}

Debugging

we use the debug module so you can debug the http requests by doing the following

DEBUG=http node myfile.js

also all methods enforce type checking so invalid usage would result in errors like this

Methods

All methods follow the official API documentation.

Droplets

• dropletGetAll(Object query [, Boolean raw])
• dropletNew(Object body, [, Boolean raw])
• dropletGet(Number id [, Boolean raw])
• dropletReboot(Number id [, Boolean raw])
• dropletPowerCycle(Number id [, Boolean raw])
• dropletShutdown(Number id [, Boolean raw])
• dropletPowerOff(Number id [, Boolean raw])
• dropletPowerOn(Number id [, Boolean raw])
• dropletPasswordReset(Number id [, Boolean raw])
• dropletResize(Number id, Object body [, Boolean raw])
• dropletSnapshot(Number id, Object body [, Boolean raw])
• dropletRestore(Number id, Object body [, Boolean raw])
• dropletRebuild(Number id, Object body [, Boolean raw])
• dropletRename(Number id, Object body [, Boolean raw])
• dropletDestroy(Number id [, Boolean raw])
• dropletKernalsGetAll(Number id, Object query [, Boolean raw])
• dropletSnapshotsGetAll(Number id, Object query [, Boolean raw])
• dropletBackupsGetAll(Number id, Object query [, Boolean raw])
• dropletActionGetAll(Number id, Object query [, Boolean raw])
• dropletNeighborsGetAll(Number id, Object query [, Boolean raw])
• dropletUpgradesGetAll(Object query [, Boolean raw])
• reportDropletNeighborsGetAll(Object query [, Boolean raw])

Account

• accountGet([Boolean raw])

Regions

• regionGetAll(Object query [, Boolean raw])

Images

• imageGetAll(Object query [, Boolean raw])
• imageDistributionGetAll(Object query [, Boolean raw])
• imageApplicationGetAll(Object query [, Boolean raw])
• imageGetMine(Object query [, Boolean raw])
• imageGet(Number id [, Boolean raw])
• imageDestroy(Number id [, Boolean raw])
• imageTransfer(Number id, Object body [, Boolean raw])
• imageToSnapshot(Number id [, Boolean raw])

SSH keys

• sshKeyGetAll(Object query [, Boolean raw])
• sshKeyAdd(Object body [, Boolean raw])
• sshKeyGet(Number id [, Boolean raw])
• sshKeyUpdate(Number id, Object body [, Boolean raw])
• sshKeyDestroy(Number id [, Boolean raw])

Sizes

• sizeGetAll(Object query [, Boolean raw])

Domains

• domainGetAll(Object query [, Boolean raw])
• domainNew(String name, Object body [, Boolean raw])
• domainGet(String name [, Boolean raw])
• domainDestroy(String name [, Boolean raw])
• domainRecordGetAll(String name, Object query [, Boolean raw])
• domainRecordNew(String name, Object body [, Boolean raw])
• domainRecordGet(String name, Number id [, Boolean raw])
• domainRecordEdit(String name, Number id, Object body [, Boolean raw])
• domainRecordDestroy(String name, Number id [, Boolean raw])

Actions

• actionsGetAll(String name [, Boolean raw])
• actionsGet(Number id [, Boolean raw])

Floating IPs

• floatingIpGetAll(Object query [, Boolean raw])
• floatingIpGet(String ip [, Boolean raw])
• floatingIpNew(Object body, [, Boolean raw])
• floatingIpDestroy(String ip [, Boolean raw])
• floatingIpAssign(String droplet_id [, Boolean raw])
• floatingIpUnassign(String droplet_id [, Boolean raw])