dropletapi

3.1.0 • Public • Published

DropletApi

NPM

(C) Oliwer Helsén (oliwer.helsen@live.com) 2015

A wrapper for DigitalOceans API v2

See Version History for changes

Installing

npm install dropletapi
npm install dropletapi --save

Features

-- DROPLETS

  • Create new Droplet
  • Retrieve an existing Droplet by id
  • List all Droplets in your account
  • Delete a Droplet by id
  • Retrieve a list of all kernels available to a Dropet
  • Retrieve snapshots for a Droplet
  • Retrieve backups for a Droplet
  • Retrieve actions for a Droplet

-- Actions

  • List all Actions
  • Retrieve an existing Action

API

createDroplet(dropletData, callback)

Create a new Droplet

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
var myNewDropletData = {
  "name": "example.com",
  "region": "nyc3",
  "size": "512mb",
  "image": "ubuntu-14-04-x64",
  "ssh_keys": null,
  "backups": false,
  "ipv6": true,
  "user_data": null,
  "private_networking": null
}
 
digitalocean.createDroplet(myNewDropletData, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

getDropletById(dropletID, callback)

Retrieve an existing Droplet by id

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.getDropletById(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

listDroplets(callback)

List all Droplets in your account

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.listDroplets(function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

deleteDroplet(dropletID, callback)

Delete a Droplet by id

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.deleteDroplet(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

availableKernelsForDroplet(dropletID, callback)

Retrieve a list of all kernels available to a Dropet

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.availableKernelsForDroplet(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

getSnapshotsForDroplet(dropletID, callback)

Retrieve the snapshots that have been created from a Droplet

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.getSnapshotsForDroplet(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

getBackupsForDroplet(dropletID, callback)

Retrieve any backups associated with a Droplet

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.getBackupsForDroplet(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

getActionsForDroplet(dropletID, callback)

Retrieve all actions that have been executed on a Droplet

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.getActionsForDroplet(PUT THE DROPLETID HERE, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

listDropletUpgrades(callback)

Retrieve a list of droplets that are scheduled to be upgraded

Example usage

var DIGITALOCEAN = require('dropletapi').Droplets;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.listDropletUpgrades(function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

listAllActions(pageData, callback)

List all of the actions that have been executed on the current account

Example usage

var DIGITALOCEAN = require('dropletapi').Actions;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.listAllActions({page: 1, per_page:1},function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

listAllActions(pageData, callback)

List all of the actions that have been executed on the current account

Example usage

var DIGITALOCEAN = require('dropletapi').Actions;
 
var digitalocean = new DIGITALOCEAN('Your API-TOKEN');
 
digitalocean.getActionById(YOUR ACTIONS ID, function (error, result) {
          if (error) {
              console.log(error);
          }
          else {
              console.log(result);
          }
      });
 

TODO

  • Keep on adding more actions from the DigitalOcean API v2

Readme

Keywords

Package Sidebar

Install

npm i dropletapi

Weekly Downloads

26

Version

3.1.0

License

ISC

Last publish

Collaborators

  • ioliwer