JSON based Web API for customer VPS

For 4 years now we’ve had an in-house API for VPS customers to automate management of their Network Presence VPS through web-based URLs that access the API and respond with simple JSON text.

Our VPS API allows you to manage & report on (any of) your Network Presence VPS and some information (contact details, VPS Plan information, etc) on the Account that owns the VPS.

API functionality includes;

+ Display the current status of your running VPS, including memory, CPU and network usage
+ Stop your VPS
+ Start your VPS
+ Get Usage information of the VPS Account
+ List your Backups of your VPS
+ Initiate a Backup of your VPS
+ Get basic information on the VPS Account
+ Regeneratable “Key” or code required with each call to the API

The way that the API works is by providing a means to generate a unique Key or code for access to the API, which means that the customer’s username and password doesn’t need to be supplied in calls to the API.

The Network Presence VPS Management page has an option to “Generate and Store an API Key”, which is returned back on-screen and should be saved for use in calls to the API.

Calling the API is as simple as supplying the “API Key” in standard (GET format) URLs, like:

API-URL/api?key=MyAPIKey?a=command

Note: please contact us for the full API-URL, as it’s not listed here in a public resource..

Where ‘command’ can be: status, info, usage, listbackup, takebackup, stop, terminate, start

status = list information about the running VPS & whether the VPS is running

info = list some account or contact information on the VPS

usage = list network traffic (for billing month to date) and other basic resource usage information on the VPS

stop = perform an ‘orderly’ shutdown of the VPS (like “pressing the power button”)

terminate = immediately shutdown the VPS (like “pulling the power cord”)

start = perform a startup or “boot up” of the VPS

listbackup = list stored backups of your VPS Disk

takebackup = Initiate a backup to be taken of your VPS Disk

All customers are welcome to use the API and please report and problems to us by email to help AT networkpresence.com.au (ie: don’t post here for API Feedback).

Of course, if you’d like a 100% AWS compatible interface for your VPS, then we can provision your VPS within a Eucalyptus based environment, on separate hosting platforms too.

FYI & regards,
Richard.

This entry was posted in Network Presence, Sales and tagged , , , . Bookmark the permalink.