digitalocean-api

digitalocean-api

The digitalocean-api is a module that allows you to communicate with the DigitalOcean API from node.js

Installation

This module is published in NPM:

npm install digitalocean-api --save

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

Usage

// Import a module
var DigitalOceanAPI = require('digitalocean-api');
// Create an instance with your API credentials
var api = new DigitalOceanAPI('client_id', 'api_key');

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

Methods

All methods follow the official API documentation.

Convention for callback arguments: callback(error, data)

Droplets

dropletGetAll(callback)
dropletGet(id, callback)
dropletNew(name, sizeId, imageId, regionId, sshKeyIds, callback)
dropletRebootHard(id, callback)
dropletPowerCycle(id, callback)
dropletShutdown(id, callback)
dropletPowerOff(id, callback)
dropletPowerOn(id, callback)
dropletResetRootPassword(id, callback)
dropletResize(id, sizeId, callback)
dropletSnapshot(id, name, callback)
dropletRestore(id, imageId, callback)
dropletRebuild(id, imageId, callback)
dropletBackupEnable(id, callback)
dropletBackupDisable(id, callback)
dropletDestroy(id, callback)

Sizes

sizeGetAll(callback)

Images

imageGetAll(callback)
imageGetGlobal(callback)
imageGetMine(callback)
imageGet(id, callback)
imageDestroy(id, callback)

SSH keys

sshKeyGetAll(callback)
sshKeyGet(id, callback)
sshKeyAdd(name, pubKey, callback)
sshKeyEdit(id, pubKey, callback)
sshKeyDestroy(id, callback)

Regions

regionGetAll(callback)