API
Abstract
The Quantact API allows control of Quantact's services over standard https, without logging into the QCP. Most functions available in the QCP are currently supported, with more available soon.
Introduction to the API
To use the Quantact API, you must have a Quantact account. You must enable API use
in the QCP on the profile page, which generates an API password that you must supply with
every API call. To disable the API for your account, delete the key in the input box, type DISABLE, and click generate key.
Getting Started
Login to the QCP and generate your API key on the profile page. The API key generated in the QCP will consist of 40 alpha numeric characters.
To test if your API key is working, use a standard https POST request, i.e. type the following into your browser:
https://api.quantact.com?apikey=abc123&action=api_help
The minimum requirement for a successful API request is an apikey.
Other functions may require additional variables, as detailed below.
Output from the API is returned in an XML layout. Output from all successful API calls will resemble the following:
<xml> <title>Quantact api</title> <tos> For authorized use only. Usage of this api is governed by the Quantact terms of service. http://www.quantact.com/aup.shtml </tos> <body> <action>api_help</action> <data> <api> <version>1.2</version> <documentation>http://docs.quantact.com/api/</documentation> </api> </data> <response> <code>1</code> <text>Action accepted</text> </response> </body> </xml>
The data portion of the API output is function specific (see below). A response code of 1 will be returned on a successful API call. Response text will explain in more detail should an API call not be valid/accepted.
Example in Perl
This link in the forums has an example of starting a backup from within your vps:
http://forums.quantact.com/viewtopic.php?f=36&t=1157
