Git Product home page Git Product logo

digitalocean.node's Introduction

digitalocean.node

Digital Ocean API client for node.js

Installation

npm install digitalocean.node

Usage

var DigitalOcean = require('digitalocean.node');

var client = new DigitalOcean({client_id: '...', api_key: '...'});

// Do something with client

Constructors

new DigitalOcean({client_id: '...', api_key: '...'})

Methods

Higher Level

client.new_droplet(config, callback)

The DigitalOcean API asks you to supply the size_id, image_id, and region_id, but what if you just don't know them and don't want to take the chance of hardcoding in case they're changed in the future? This method will allow you to just use the names of each.

config
  • name: Name you want to call the instance
  • size: The name of the size you'd like. i.e. "512MB", "1GB", "2GB", etc.
  • image: The name of the image you'd like. i.e. "Ubuntu 12.04 x64", "Docker on Ubuntu 13.04", etc.
  • region: The name of the image you'd like. i.e. "San Francisco 1", "New York 2", etc.
  • ssh_key or ssh_keys: The name or names of the ssh key or ssh keys that you would like to associate with this instance.

Example

client.new_droplet({
  name: 'my-server'
  size: '1GB'
  image: 'Ubuntu 12.04 x64'
  region: 'San Francisco 1'
  ssh_key: 'awesomeness'
} , function(err, instance) {
  console.log(instance);
});

Droplets

client.droplets.list(callback)

client.droplets.by_name(name, callback)

client.droplets.new(callback)

client.droplet(id).get(callback)

client.droplet(id).destroy(callback)

Regions

client.regions.list(callback)

Images

client.images.list(callback)

SSH Keys

client.ssh_keys.list(callback)

Sizes

client.sizes.list(callback)

Domains

client.domains.list(callback)

License

Copyright (c) 2013 Matt Insler
Licensed under the MIT license.

digitalocean.node's People

Contributors

mattinsler avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.