https://github.com/robflaherty/webfaction-api
https://github.com/robflaherty/webfaction-api
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/robflaherty/webfaction-api
- Owner: robflaherty
- Created: 2013-12-02T13:49:02.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-12-03T21:07:54.000Z (over 12 years ago)
- Last Synced: 2025-03-26T08:04:22.993Z (over 1 year ago)
- Language: JavaScript
- Size: 1.06 MB
- Stars: 7
- Watchers: 1
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Webfaction API
This is a Node.js wrapper for Webfaction's [XML-RPC API](http://docs.webfaction.com/xmlrpc-api/). It's currently incomplete but functional for the parts of the API it supports (listed below). Use at your own risk. Be careful with destructive operations.
It needs tests, better error handling, and coverage for the other sections of the API (email, DNS, etc). Contributions welcome!
## Installation
```
npm install webfaction-api
```
## Basic Usage
```javascript
var Webfaction = require('webfaction-api');
var webfaction = new Webfaction('username', 'password');
webfaction.login(function(result) {
webfaction.listDomains(function(result) {
console.log(result);
});
webfaction.createWebsite({
website_name : 'example',
ip: '123.45.67.89',
https: false,
subdomains: ['www.example.com'],
site_apps: [ ['node', '/'] ]
},
function(result) {
console.log(result);
});
});
```
## API
### Supported API Calls
* Domains
* Create Domain
* Delete Domain
* List Domains
* Applications
* Create Application
* Delete Application
* List Applications
* List Application Types
* Websites
* Create Website
* Update Website
* Delete Website
* List Websites
* Servers
* List IPs
* List Machines
* Cron
* Create Cron job
* Delete Cron job