The doapi module allows you to communicate with the DigitalOcean API V2 from node.js in a promise friendly manner.
It also supports automatic request retries.
This module is published in NPM:
npm install doapi --save
The --save tells NPM to automatically add it to your package.json file
// Import a module
var DigitalOceanAPI = require('doapi');
// Create an instance with your API V2 credentials
var api = new DigitalOceanAPI({token: 'my_token'});
// Get things done
api.dropletGetAll().then(function (droplets) {
console.log(droplets);
});
new DigitalOceanAPI({
token: 'my_token',
itemsPerPage: 100, // default=100
maxRetries: 5, // default=5
raw: false // default=false
});
you can pass pagination params into any method that has a body or query argument.
api.dropletGetAll({per_page: 1, page: 2}).then(function (droplets) {
console.log(droplets);
});
if you set raw it will return the full response body with request info and ratelimiting details, the default is false.
api.accountGet(true)
would return
{
account: {
droplet_limit: 25,
email: 'email@domain.com',
uuid: 'f5bbaffce3a8792421593a7075b486bafd66672f',
email_verified: true
},
ratelimit: {
limit: '5000',
remaining: '4993',
reset: '1434197547'
},
requestinfo: {
id: 'a24427fd-0d43-9536-a206-zac22d2696e1',
runtime: '0.038537'
}
}
and with raw set to false (the default), it would return
{
droplet_limit: 25,
email: 'email@domain.com',
uuid: 'f5bbaffce3a8792421593a7075b486bafd66672f',
email_verified: true
}
we use the debug module so you can debug the http requests by doing the following
DEBUG=http node myfile.js
also all methods enforce type checking so invalid usage would result in errors like this
All methods follow the official API documentation.
FAQs
DigitalOcean V2 API wrapper
The npm package doapi receives a total of 19 weekly downloads. As such, doapi popularity was classified as not popular.
We found that doapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket Firewall Enterprise is now available with flexible deployment, configurable policies, and expanded language support.
Security News
Open source dashboard CNAPulse tracks CVE Numbering Authorities’ publishing activity, highlighting trends and transparency across the CVE ecosystem.
Product
Detect malware, unsafe data flows, and license issues in GitHub Actions with Socket’s new workflow scanning support.