digitalocean-api

    0.1.1 • Public • Published

    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.

    More detailed documentation generated from the source code is available.

    Convention for callback arguments: callback(error, data)

    Droplets

    dropletGetAll(callback)
    dropletNew(name, sizeId, imageId, regionId, optionals, callback)
    dropletGet(id, callback)
    dropletReboot(id, callback)
    dropletPowerCycle(id, callback)
    dropletShutdown(id, callback)
    dropletPowerOff(id, callback)
    dropletPowerOn(id, callback)
    dropletPasswordReset(id, callback)
    dropletResize(id, sizeId, callback)
    dropletSnapshot(id, optionals, callback)
    dropletRestore(id, imageId, callback)
    dropletRebuild(id, imageId, callback)
    dropletRename(id, name, callback)
    dropletDestroy(id, callback)

    Regions

    regionGetAll(callback)

    Images

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

    SSH keys

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

    Sizes

    sizeGetAll(callback)

    Domains

    domainGetAll(callback)
    domainNew(name, ipAddress, callback)
    domainGet(id, callback)
    domainDestroy(id, callback)
    domainRecordGetAll(id, callback)
    domainRecordNew(id, recordType, data, optionals, callback)
    domainRecordGet(id, recordId, callback)
    domainRecordEdit(id, recordId, recordType, data, optionals, callback)
    domainRecordDestroy(id, recordId, callback)

    Events

    eventGet(id, callback)

    Keywords

    none

    Install

    npm i digitalocean-api

    DownloadsWeekly Downloads

    1

    Version

    0.1.1

    License

    none

    Last publish

    Collaborators

    • avatar