Linode API client for Node.js
CoffeeScript JavaScript
Latest commit 9d3ef43 Jan 11, 2013 @fictorial Merge pull request #4 from bluesmoon/patch-1
Check for ERRORARRAY before checking its length
Permalink
Failed to load latest commit information.
bin Remove runtime dependency on CoffeeScript Jun 15, 2011
data initial commit Jun 14, 2011
examples Add another example Jun 15, 2011
src Return object if obj.DATA not set Jan 8, 2013
test initial commit Jun 14, 2011
tools initial commit Jun 14, 2011
.gitignore initial commit Jun 14, 2011
.npmignore initial commit Jun 14, 2011
Makefile Remove runtime dependency on CoffeeScript Jun 15, 2011
README.md fix example Jun 14, 2011
package.json

README.md

Linode API Client

A client for the Linode API.

API Key

Your API key can be found here.

Installation

npm install linode-api

Usage

var my_api_key = '...';
var client = new(require('linode-api').LinodeClient)(my_api_key);
client.call('test.echo', {msg: "hello, self!"}, function (err, res) {
  if (err) throw err;
  console.log("I said '" + res.msg + "' to myself. Whee!");
});

Updating the API

Should Linode update their API, we can auto-regenerate the API methods by running 'make api'. Linode does not provide a machine-readable API specification so this resorts to scraping their HTML documentation.

Roadmap

  • Add basic validation for required parameters (already parsed)

Author

Brian Hammond brian@fictorial.com (http://fictorial.com)

License

Copyright (c) 2011 Fictorial LLC.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.