digitalocean-node is a library for nodejs to access the DigitalOcean v2 API.
npm install digitalocean --save
Every resource is accessed via an instance of the client. Please chose one of your tokens and use that where ever TOKEN is referenced. For example:
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN'); // See
// client.{ RESOURCE_NAME }.{ METHOD_NAME }Every resource method accepts an optional callback as the last argument. For example:
client.account.get(function(err, account) {
console.log(err); // null on success
console.log(account); //
});See below for more options in the callback.
Resource methods also return a promise. For example:
client.droplets.list().then(function(droplets) {
var droplet = droplets[0];
return client.droplets.snapshot(droplet.id);
}).then(function() {
console.log("created a snapshot of a Droplet!");
}).catch(function(err) {
// Deal with an error
});All resources and actions are listed below, however, the general structure of the client follows the following pattern:
client.droplets.list(callback);
client.droplets.create(options, callback);
client.droplets.get(123, callback);
client.droplets.delete(123, callback);
client.droplets.powerOff(123, callback);
client.droplets.getAction(123, 456, callback);The DigitalOcean client depends on request, and options can be passed through (e.g. a proxy or user agent). For example:
var client = digitalocean.client('TOKEN', {
request: myInitializedRequestObject,
requestOptions: {
proxy: 'https://myproxy.com:1085',
headers: {
'User-Agent': 'foo'
}
}
});Other options include:
var client = digitalocean.client('TOKEN', {
promise: MySpecialPromiseVersion, // defaults to Promise
decamelizeKeys: false // defaults to true
});var client = digitalocean.client('TOKEN');
client.get('/account', {}, 200, 'account', function (err, status, body, headers) {
console.log(body); //json object
});All callbacks will be passed:
- an error (null if no error occurred)
- a resource object
- the response headers
- the raw response body
For example:
client.account.get(function(err, account, headers, response) {
console.log("error: " + err);
console.log("account: " + account);
console.log("headers: " + headers);
console.log("response: " + response);
});Promise results are the resource(s) returned by a successful response - an array, an individual object, or a blank object (for successful empty responses such as deletes). These objects have a special property, _digitalOcean that includes response information. For example:
// ...
.then(function(object) {
console.log(object); // =>
// {
// _digitalOcean: {
// statusCode: 204,
// body: {},
// headers: {}
// }
// }
})If a function is said to be supporting pagination, then that function can be used in many ways as shown below. Results from the function are arranged in pages.
The page argument is optional and is used to specify which page of objects to retrieve.
The perPage argument is also optional and is used to specify how many objects per page.
// Normal usage of function
client.droplets.list(callback); // Callback receives an array of first 25 issues
// Using pagination parameters
client.droplets.list(2, 100, callback); // Callback receives an array of second 100 issues
client.droplets.list(10, callback); // Callback receives an array of 25 issues from page 10
// Pagination parameters can be set with query object too
client.droplets.list({
page: 2,
per_page: 100
}, callback); //array of second 100 issues which are closedTo fetch all the pages of a resource, the pages must be traversed. For example, to fetch all Droplets:
getAllDroplets(function(allDroplets) {
console.log(allDroplets.length);
});
function getAllDroplets(callback, page, array) {
client.droplets.list(page, function(err, droplets, _, response) {
if (err) {
return console.error('Error fetching pages', err);
}
if (page == null) {
page = 1;
}
if (array == null) {
array = [];
}
array = array.concat(droplets);
// has no pages or has pages and has no last page
var isLastPage = response['links'] && (
!response['links']['pages'] ||
(response['links']['pages'] && response['links']['pages']['last'] === undefined)
);
if (!err && isLastPage) {
callback.call(this, array);
} else if (!err && !isLastPage) {
listPagesUntilDone(page + 1, callback, array);
} else {
// whoops, try again
listPagesUntilDone(page, callback, array);
}
})
};Or Promise style:
getAllDroplets().then(function(allDroplets) {
console.log(allDroplets);
}).catch(function(err) {
console.log(err);
});
function getAllDroplets() {
var allDroplets = [];
function getDropletPage(page) {
if (page == null) {
page = 1;
}
return client.droplets.list(page)
.each(function(droplet) {
allDroplets.push(droplet);
})
.then(function(droplets) {
var links = droplets._digitalocean.body.links;
var isLastPage = links && (
!links.pages ||
(links.pages && links.pages.last === undefined)
);
if (isLastPage) {
return allDroplets;
} else {
return getDropletPage(page + 1);
}
});
}
return getDropletPage();
}
You can also check your rate limit status by calling the following.
client.droplets.list(function (err, account, headers, response) {
console.log(headers['ratelimit-remaining']); // 4999
console.log(headers['ratelimit-limit']); // 5000
console.log(headers['ratelimit-reset']); // Time in Unix Epoch, e.g. 1415984218
});This library is also available as a single file built for usage in the browser at dist/digitalocean.js. It uses browserify to package all dependencies and output the built file. This file is updated and released to Bower for each release with the same version.
For example, using the built file at dist/digitalocean.js:
<html>
<head></head>
<body>
<script src="dist/digitalocean.js"></script>
<script>
var client = digitalocean.client('TOKEN');
client.account.get(function(_, account) {
console.log(account.uuid);
});
</script>
</body>
</html>Where you see attributes it is a plain JavaScript object, e.g. { email: '[email protected]' }
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.dropletsclient.droplets.list([page, perPage,] [callback])client.droplets.list([queryObject,] [callback])client.droplets.get(droplet.id, [callback])client.droplets.create(attributes, [callback])client.droplets.delete(droplet.id, [callback])client.droplets.deleteByTag(tag.name, [callback])client.droplets.kernels(droplet.id, [page, perPage,] [callback])client.droplets.kernels(droplet.id, [queryObject] [callback])client.droplets.snapshots(droplet.id, [page, perPage,] [callback])client.droplets.snapshots(droplet.id, [queryObject] [callback])client.droplets.backups(droplet.id, [page, perPage,] [callback])client.droplets.backups(droplet.id, [queryObject] [callback])client.droplets.neighbors(droplet.id, [page, perPage,] [callback])client.droplets.neighbors(droplet.id, [queryObject] [callback])client.droplets.listActions(droplet.id, [page, perPage,] [callback])client.droplets.listActions(droplet.id, [queryObject] [callback])client.droplets.getAction(droplet.id, action.id, [callback])
For the latest valid attributes, see the official docs.
Methods resulting in an action:
client.droplets.actionByTag(tag.name, actionType, [callback])client.droplets.reboot(droplet.id, [callback])client.droplets.powerCycle(droplet.id, [callback])client.droplets.shutdown(droplet.id, [callback])client.droplets.powerOff(droplet.id, [callback])client.droplets.powerOn(droplet.id, [callback])client.droplets.passwordReset(droplet.id, [callback])client.droplets.enableIpv6(droplet.id, [callback])client.droplets.enableBackups(droplet.id, [callback])client.droplets.disableBackups(droplet.id, [callback])client.droplets.enablePrivateNetworking(droplet.id, [callback])client.droplets.snapshot(droplet.id, parametersOrName, [callback])client.droplets.changeKernel(droplet.id, parametersOrKernelId, [callback])client.droplets.rename(droplet.id, parametersOrHostname, [callback])client.droplets.rebuild(droplet.id, parametersOrImage, [callback])client.droplets.restore(droplet.id, parametersOrImageId, [callback])client.droplets.resize(droplet.id, parametersOrSizeSlug, [callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.drivesclient.drives.list([page, perPage,] [callback])client.drives.list([queryObject] [callback])
See the official docs on different parameters to pass via the query object to filter the drives.
client.drives.get(tag.name, [callback])client.drives.create(attributes, [callback])
For the latest valid attributes, see the official docs.
client.drives.delete(tag.name, [callback])
Methods resulting in an action:
client.drives.attach(drive.id, parametersOrDropletId, [callback])client.drives.detach(drive.id, [callback])client.drives.listActions(drive.id, [page, perPage,] [callback])client.drives.listActions(drive.id, [queryObject] [callback])client.drives.getAction(drive.id, action.id, [callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.domainsclient.domains.list([page, perPage,] [callback])client.domains.list([queryObject,] [callback])client.domains.create(attributes, [callback])client.domains.get(domain.name, [callback])client.domains.delete(domain.name, [callback])client.domains.listRecords([page, perPage,] domain.name, [callback])client.domains.listRecords([queryObject,] domain.name, [callback])client.domains.createRecord(domain.name, attributes, [callback])client.domains.getRecord(domain.name, domainRecord.id, [callback])client.domains.deleteRecord(domain.name, domainRecord.id, [callback])client.domains.updateRecord(domain.name, domainRecord.id,, attributes, [callback])
For the latest valid domain attributes, see the official docs. For the latest valid domain record attributes, see the official docs.
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.imagesclient.images.list([page, perPage,] [callback])client.images.list([queryObject,] [callback])
See the official docs on different parameters to pass via the query object to filter the images.
client.images.get(image.id, [callback])client.images.delete(image.id, [callback])client.images.update(image.id, attributes, [callback])client.image.listActions([page, perPage,] image.id, [callback])client.image.listActions([queryObject] image.id, [callback])client.image.getAction([page, perPage,] image.id, action.id, [callback])client.image.getAction([queryObject] image.id, action.id, [callback])
Methods resulting in an action:
client.image.transfer(image.id, parametersOrRegionSlug, [callback])client.image.convert(image.id, [callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.regionsclient.regions.list([callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.sizesclient.sizes.list([callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.accountclient.account.get([callback])client.account.listSshKeys([page, perPage,] [callback])client.account.listSshKeys([queryObject] [callback])client.account.createSshKey(attributes, [callback])client.account.getSshKey(sshKey.id, [callback])client.account.deleteSshKey(sshKey.id, [callback])client.account.updateSshKey(sshKey.id, attributes, [callback])
For the latest ssh key valid attributes, see the official docs.
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.floatingIpsclient.floatingIps.list([page, perPage,] [callback])client.floatingIps.list([queryObject] [callback])client.floatingIps.get(floatingIp.ip, [callback])client.floatingIps.create(attributes, [callback])client.floatingIps.delete(floatingIp.ip, [callback])client.floatingIps.listActions([page, perPage,] [callback])client.floatingIps.listActions([queryObject] [callback])client.floatingIps.getAction(floatingIp.ip, [callback])
For the latest valid attributes, see the official docs.
Methods resulting in an action:
client.floatingIps.assign(floatingIp.ip, parametersOrDropletId, [callback])client.floatingIps.unassign(floatingIp.ip, [callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.volumesclient.volumes.list([page, perPage,] [callback])client.volumes.list([queryObject] [callback])client.volumes.get(floatingIp.ip, [callback])client.volumes.create(attributes, [callback])client.volumes.delete(floatingIp.ip, [callback])client.volumes.listActions([page, perPage,] [callback])client.volumes.listActions([queryObject] [callback])client.volumes.getAction(floatingIp.ip, [callback])
For the latest valid attributes, see the official docs.
Methods resulting in an action:
client.volumes.attach(volume.id, parametersOrDropletId, [callback])client.volumes.detach(volume.id, [callback])client.volumes.resize(volume.id, parametersOrSizeGibabytes, region, [callback])
var digitalocean = require('digitalocean');
var client = digitalocean.client('TOKEN');
client.tagsclient.tags.list([page, perPage,] [callback])client.tags.list([queryObject] [callback])client.tags.get(tag.name, [callback])client.tags.create(attributes, [callback])client.tags.update(tag.name, attributes, [callback])client.tags.tag(tag.name, [{resource_id: , resource_type: }], [callback])client.tags.untag(tag.name, [{resource_id: , resource_type: }], [callback])client.tags.delete(tag.name, [callback])
For the latest valid attributes, see the official docs.
- Fork it ( https://github.com/phillbaker/digitalocean-node/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
npm test
Run:
npm run release:patch # or release:minor or release:major depending on the type of version bumpMIT
Based on the work of @pksunkara in octonode.