http://dropzonewiki.singlehop.com/api.php?action=feedcontributions&user=Jcohen&feedformat=atomINAP Dropzone API - User contributions [en]2024-03-29T14:17:33ZUser contributionsMediaWiki 1.18.1http://dropzonewiki.singlehop.com/index.php?title=API_Command_ExamplesAPI Command Examples2012-07-18T20:28:33Z<p>Jcohen: </p>
<hr />
<div>==Viewing a Support Ticket==<br />
For more information about the command and what data is required and returned when viewing a support ticket through the [[glossary#API|API]] please go to [[Support View]].<br />
<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/support/view/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Replying to a Support Ticket==<br />
For more information about the command and what data is required and returned when replying to a support ticket through the [[glossary#API|API]] please go to [[<br />
Support_Reply]].<br />
<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/support/reply',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => TRUE,<br />
CURLOPT_POSTFIELDS => 'ticketid=123456&subject=RE: Server Setup&message=This server setup is awesome.&contact=admin@test.com',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Viewing an Invoice==<br />
For more information about the command and what data is required and returned when viewing an invoice through the [[glossary#API|API]] please go to [[Billing_View]].<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/billing/view/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Create a Virtual Machine==<br />
For more information about the command and what data is required and returned when creating a [[glossary#Virtual Machine|virtual machine]] through the [[glossary#API|API]] please go to [[Server Create VM]].<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/server/createvm/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => TRUE,<br />
CURLOPT_POSTFIELDS => 'serverid=12345&hostname=vm1.server.com&osid=1&ips=30&storagetype=canopy&memory=524288&storage=10485760&cpu_allocation=pool&priority=100',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=API_Command_ExamplesAPI Command Examples2012-07-18T20:27:02Z<p>Jcohen: Created page with "==Viewing a Support Ticket== For more information about the command and what data is required and returned when viewing a support ticket through the API pleas..."</p>
<hr />
<div>==Viewing a Support Ticket==<br />
For more information about the command and what data is required and returned when viewing a support ticket through the [[glossary#API|API]] please go to [[Support View]].<br />
<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/support/view/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => FALSE,<br />
CURLOPT_POSTFIELDS => '',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Replying to a Support Ticket==<br />
For more information about the command and what data is required and returned when replying to a support ticket through the [[glossary#API|API]] please go to [[<br />
Support_Reply]].<br />
<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/support/reply',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => TRUE,<br />
CURLOPT_POSTFIELDS => 'ticketid=123456&subject=RE: Server Setup&message=This server setup is awesome.&contact=admin@test.com',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Viewing an Invoice==<br />
For more information about the command and what data is required and returned when viewing an invoice through the [[glossary#API|API]] please go to [[Billing_View]].<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/billing/view/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => FALSE,<br />
CURLOPT_POSTFIELDS => '',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre><br />
<br />
<br />
==Create a Virtual Machine==<br />
For more information about the command and what data is required and returned when creating a [[glossary#Virtual Machine|virtual machine]] through the [[glossary#API|API]] please go to [[Server Create VM]].<br />
<br />
<pre><br />
$options = array(<br />
CURLOPT_URL => 'http://USERNAME:PASSWORD'@dropzone.singlehop.com/server/createvm/123456',<br />
CURLOPT_RETURNTRANSFER => TRUE,<br />
CURLOPT_HEADER => FALSE,<br />
CURLOPT_CONNECTTIMEOUT => 120,<br />
CURLOPT_TIMEOUT => 120,<br />
CURLOPT_POST => TRUE,<br />
CURLOPT_POSTFIELDS => 'serverid=12345&hostname=vm1.server.com&osid=1&ips=30&storagetype=canopy&memory=524288&storage=10485760&cpu_allocation=pool&priority=100',<br />
CURLOPT_SSL_VERIFYHOST => FALSE,<br />
CURLOPT_SSL_VERIFYPEER => FALSE,<br />
CURLOPT_VERBOSE => TRUE,<br />
);<br />
$ch = curl_init();<br />
curl_setopt_array($ch, $options);<br />
$return = curl_exec($ch);<br />
echo json_decode($return);<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Server_Create_VMServer Create VM2012-07-18T20:21:47Z<p>Jcohen: </p>
<hr />
<div>The [[Server|server]] create VM command <br />
==Path==<br />
*/server/createvm<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Availability==<br />
*[[servers#Dynamic Server|Dynamic Server]]<br />
<br />
==Required Data Parameters==<br />
*{$serverid}: The server ID of the [[servers#Dynamic Server|Dynamic Server]] that the new [[glossary#Virtual Machine|virtual machine]] will be created on. The server ID is returned using the [[Server List|list]] command.<br />
<br />
<br />
*{$hostname}: The hostname of new [[glossary#Virtual Machine|virtual machine]], it must be unique and not currently in use on any other server or [[glossary#Virtual Machine|virtual machine]] in [[glossary#LEAP|LEAP]].<br />
*{$osid}: The operating system that will be installed on the [[glossary#Virtual Machine|virtual machine]], all operating systems available will be returned by using the [[Server List Snapshots|list snapshots]] command.<br />
*{$ips}: The number of IP addresses to be assigned to the [[glossary#Virtual Machine|virtual machine]] in cidr format (30 = 1 Usable, 29 = 5 Usable, 28 = 13 Usable, 27 = 29 Usable)<br />
*{$storagetype}: The type of storage that the [[glossary#Virtual Machine|virtual machine]] will use (canopy = cloud storage, local = servers local hard drive).<br />
*{$memory}: The amount of RAM assigned to the [[glossary#Virtual Machine|virtual machine]] in kilobytes, it must be greater than 512 MB (524,288 KB).<br />
*{$storage}: The amount of storage space assigned to the [[glossary#Virtual Machine|virtual machine]] in kilobytes, must be greater than 10GB (10,485,760 KB).<br />
*{$cpu_allocation}: How vcpus/priority should be applied to a new virtual machine.<br />
**{$priority}: The CPU priority for the [[glossary#Virtual Machine|virtual machine]] (1 – 100)%, (pool, limited, dedicated).<br />
*** If $cpu_allocation is 'dedicated', priority isn't used. If $cpu_allocation is 'limited', a VM will have access to multiple cores and will have a set priority to those cores. if $cpu_allocation is set to 'pool', the VM has access to the whole physical CPU but are limited to the priority they're assigned.<br />
**{$cores}: Number of vCPUs to assign to a virtual machine.<br />
*** If $cpu_allocation is 'dedicated', these cores are removed from the cpu pool and actually allocated to the VM so they cannot be used by other VMs. If $cpu_allocation is set to 'limited', the VM has access to that number of cores but may share them with other VMs. Cores do not apply if $cpu_allocation is set to 'pool'<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[vmid] => The server ID of the new VM.<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Support_ReplySupport Reply2012-07-18T20:09:41Z<p>Jcohen: </p>
<hr />
<div>The [[Support|support]] reply command<br />
==Path==<br />
*/support/repy<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$ticketid}: The ticket ID retrieved from from the [[Support List|support list]] command.<br />
*{$message}: The message that will be sent to [[glossary#SingleHop|SingleHop]].<br />
*{$subject}: The subject of the reply.<br />
*{$contact}: The contact that is sending the reply..<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=GlossaryGlossary2012-07-18T19:59:45Z<p>Jcohen: /* cURL */</p>
<hr />
<div>==API==<br />
An Application Programming Interface (API) is a source code-based specification intended to be used as an interface by software components to communicate with each other. An API may include specifications for routines, data structures, object classes, and variables. An API specification can take many forms, including an International Standard such as POSIX or vendor documentation such as the Microsoft Windows API, or the libraries of a programming language, e.g. Standard Template Library in C++ or Java API.<br />
<br />
==Canopy Storage==<br />
<br />
<br />
==CVV2==<br />
The Card Verification Value (CVV or CVV2), card security code (CSC), sometimes called Card Verification Data (CVD), Card Verification Value Code (CVVC), Card Verification Code (CVC or CVC2), Verification Code (V-Code or V Code), or Card Code Verification (CCV) are different terms for security features for credit or debit card transactions, providing increased protection against credit card fraud.<br />
<br />
==cURL==<br />
[http://php.net/manual/en/book.curl.php http://php.net/manual/en/book.curl.php]<br />
<br />
==GET==<br />
Requests a representation of the specified resource. Requests using GET should only retrieve data and should have no other effect. (This is also true of some other HTTP methods.) The W3C has published guidance principles on this distinction, saying, "Web application design should be informed by the above principles, but also by the relevant limitations." See safe methods below.<br />
<br />
==FQDN==<br />
<br />
<br />
==LEAP==<br />
<br />
<br />
==JSON==<br />
<br />
<br />
==PDF==<br />
Portable Document Format (PDF) is an open standard for document exchange. This file format, created by [http://en.wikipedia.org/wiki/Adobe_Systems Adobe Systems] in 1993, is used for representing documents in a manner independent of application software, hardware, and operating systems. Each PDF file encapsulates a complete description of a fixed-layout flat document, including the text, fonts, graphics, and other information needed to display it.<br />
<br />
==POST==<br />
Submits data to be processed (e.g., from an HTML form) to the identified resource. The data is included in the body of the request. This may result in the creation of a new resource or the updates of existing resources or both.<br />
<br />
==Provision==<br />
When any servers status is set to "Provisioning", what this means is that the server is currently being setup and installed with all the data, software and to make it ready for network operation.<br />
<br />
==RDNS==<br />
<br />
<br />
==SingleHop==<br />
<br />
<br />
==Sub Account==<br />
<br />
<br />
==Virtual Machine==<br />
The term Virtual Machine is used to refer to either a [[servers#Private Cloud|private]] or [[servers#Public Cloud|public]] cloud server.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=GlossaryGlossary2012-07-18T19:57:40Z<p>Jcohen: </p>
<hr />
<div>==API==<br />
An Application Programming Interface (API) is a source code-based specification intended to be used as an interface by software components to communicate with each other. An API may include specifications for routines, data structures, object classes, and variables. An API specification can take many forms, including an International Standard such as POSIX or vendor documentation such as the Microsoft Windows API, or the libraries of a programming language, e.g. Standard Template Library in C++ or Java API.<br />
<br />
==Canopy Storage==<br />
<br />
<br />
==CVV2==<br />
The Card Verification Value (CVV or CVV2), card security code (CSC), sometimes called Card Verification Data (CVD), Card Verification Value Code (CVVC), Card Verification Code (CVC or CVC2), Verification Code (V-Code or V Code), or Card Code Verification (CCV) are different terms for security features for credit or debit card transactions, providing increased protection against credit card fraud.<br />
<br />
==cURL==<br />
<br />
<br />
==GET==<br />
Requests a representation of the specified resource. Requests using GET should only retrieve data and should have no other effect. (This is also true of some other HTTP methods.) The W3C has published guidance principles on this distinction, saying, "Web application design should be informed by the above principles, but also by the relevant limitations." See safe methods below.<br />
<br />
==FQDN==<br />
<br />
<br />
==LEAP==<br />
<br />
<br />
==JSON==<br />
<br />
<br />
==PDF==<br />
Portable Document Format (PDF) is an open standard for document exchange. This file format, created by [http://en.wikipedia.org/wiki/Adobe_Systems Adobe Systems] in 1993, is used for representing documents in a manner independent of application software, hardware, and operating systems. Each PDF file encapsulates a complete description of a fixed-layout flat document, including the text, fonts, graphics, and other information needed to display it.<br />
<br />
==POST==<br />
Submits data to be processed (e.g., from an HTML form) to the identified resource. The data is included in the body of the request. This may result in the creation of a new resource or the updates of existing resources or both.<br />
<br />
==Provision==<br />
When any servers status is set to "Provisioning", what this means is that the server is currently being setup and installed with all the data, software and to make it ready for network operation.<br />
<br />
==RDNS==<br />
<br />
<br />
==SingleHop==<br />
<br />
<br />
==Sub Account==<br />
<br />
<br />
==Virtual Machine==<br />
The term Virtual Machine is used to refer to either a [[servers#Private Cloud|private]] or [[servers#Public Cloud|public]] cloud server.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=API_BasicsAPI Basics2012-07-18T18:30:42Z<p>Jcohen: /* Modules */</p>
<hr />
<div>Each [[glossary#API|API]] module includes a set of functions which allow access to [[glossary#SingleHop|SingleHop's]] data. The Dropzone [[glossary#API|API]] is a RESTful [[glossary#API|API]] which makes use of [[glossary#GET|GET]] and [[glossary#POST|POST]] to receive commands and required data. When a data set is returned from the [[glossary#API|API]] it is return as a [[glossary#JSON|JSON]] object.<br />
<br />
Some functions are dependent on others. For example, if you want to execute the [[Server View|server view]] command in the [[Server|server]] module, you will need to provide [[glossary#SingleHop|SingleHop]] with the appropriate server ID. To find the right server ID you will first need to run the [[Server List|server list]] command. The response from the [[Server List|server list]] command will contain a list of all the [[Servers|servers]] that you have from [[glossary#SingleHop|SingleHop]]. From this list of server records you would find the server ID that is required by the [[Server View|server view]] command.<br />
<br />
<br />
==The API End Point==<br />
Each API web request should be directed at:<br />
<br />
[https://dropzone.singlehop.com/ https://dropzone.singlehop.com/]<br />
<br />
==Authentication==<br />
To authenticate with the Dropzone [[glossary#API|API]] you use your username and password for [[glossary#LEAP|LEAP]]<br />
<br />
When sending your username and password you will need to provide it with every command that you send.<br />
<br />
https://USERNAME:PASSWORD@dropzone.singlehop.com/<br />
<br />
==Modules==<br />
For each module that you would like to interact with you will need to send the name of the module with the API endpoint.<br />
<br />
https://USERNAME:PASSWORD@dropzone.singlehop.com/MODULE/<br />
<br />
The [[glossary#LEAP|LEAP]] [[glossary#API|API]] consists of 8 modules that can be accessed.<br />
#[[Billing]]<br />
#[[Order]]<br />
#[[Server]]<br />
#[[Service]]<br />
#[[Solution]]<br />
#[[Support]]<br />
#[[Tandem]]<br />
#[[User]]<br />
<br />
==Commands==<br />
Each [[glossary#API|API]] module consists of a variety of commands and on each page about the command you will find information on how to use the command and what data is required to be sent the [[glossary#API|API]] end point.<br />
<br />
https://USERNAME:PASSWORD@dropzone.singlehop.com/MODULE/COMMAND/<br />
<br />
==Example Request & Response==<br />
The entire request put together would look like this;<br />
<br />
https://USERNAME:PASSWORD@dropzone.singlehop.com/server/list/<br />
<br />
<br />
<br />
The responses that are received from the [[glossary#API|API]] will be a [[glossary#JSON|JSON]] object. For instance the [[Server List|server list]] command would return;<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => Array(<br />
[0] => stdClass Object(<br />
[status] => Server status (online,offline,provisioning).<br />
[serverid] => Server ID number.<br />
[os] => Currently installed operating system.<br />
[hostname] => Server host name, as in "leap.singlehop.com".<br />
[ram] => Amount of RAM and type installed.<br />
[type] => Type of server (server,vmnode,vm).<br />
[cputype] => Type of CPU that is currently installed.<br />
[cpuspeed] => Speed of the installed CPU in GHz.<br />
)<br />
)<br />
)<br />
</pre><br />
<br />
Every response returns 'success' and will always be either TRUE or FALSE, though many replies contain additional data. If success is FALSE then there will be an accompanying message parameter, 'error', which will be returned as well and explain what went wrong.<br />
<br />
==Using PHP to Connect==<br />
We suggest that you use cURL/libcurl to handle requests to Dropzone. Using [[glossary#cURL|cURL]] allows you to gather a ton of extra information about the request (as shown below) instead of just the response -- this could save a lot of time with troubleshooting and connection issues. <br />
<br />
<pre><br />
Array(<br />
[url] => http://dropzone.singlehop.com/server/list<br />
[content_type] => text/html; charset=UTF-8<br />
[http_code] => 200<br />
[header_size] => 172<br />
[request_size] => 117<br />
[filetime] => -1<br />
[ssl_verify_result] => 0<br />
[redirect_count] => 0<br />
[total_time] => 0.100578<br />
[namelookup_time] => 2.3E-05<br />
[connect_time] => 7E-05<br />
[pretransfer_time] => 0.000113<br />
[size_upload] => 0<br />
[size_download] => 28<br />
[speed_download] => 278<br />
[speed_upload] => 0<br />
[download_content_length] => 28<br />
[upload_content_length] => 0<br />
[starttransfer_time] => 0.100548<br />
[redirect_time] => 0<br />
[request_header] => GET /server/list HTTP/1.1<br />
Authorization: Basic *****HIDDEN*********<br />
Host: dropzone.singlehop.com<br />
Accept: application/json<br />
)<br />
</pre><br />
<br />
For more information relating to [[glossary#cURL|cURL]] for PHP, please visit [http://php.net/manual/en/book.curl.php http://php.net/manual/en/book.curl.php].</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_Edit_Public_VMSolution Order Edit Public VM2012-06-03T20:17:13Z<p>Jcohen: Created page with "The solution order edit public VM command ==Path== */solution/order/editpublicvm ==Method== *POST ==Required Data Parameters== *{$objectid}: ..."</p>
<hr />
<div>The [[Solution|solution]] order edit public VM command <br />
==Path==<br />
*/solution/order/editpublicvm<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$objectid}: The ID of the object being edited. The object ID can be retrieved from Solution Order View -> objects.<br />
*{$services}: A [[glossary#JSON|JSON]] encoded array with all the settings to be set with order.<br />
*{$services}: A [[glossary#JSON|JSON]] encoded array with all the services to be included with order.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[solutionid] => The ID of the solution.<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_Edit_ServerSolution Order Edit Server2012-06-03T20:17:11Z<p>Jcohen: Created page with "The solution order edit server command ==Path== */solution/order/editserver ==Method== *POST ==Required Data Parameters== *{$objectid}: The I..."</p>
<hr />
<div>The [[Solution|solution]] order edit server command <br />
==Path==<br />
*/solution/order/editserver<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$objectid}: The ID of the object being edited. The object ID can be retrieved from Solution Order View -> objects.<br />
*{$services}: A [[glossary#JSON|JSON]] encoded array with all the services to be included with order.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[solutionid] => The ID of the solution.<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_Edit_VM_NodeSolution Order Edit VM Node2012-06-03T20:17:08Z<p>Jcohen: Created page with "The solution order edit VM node command ==Path== */solution/order/editvmnode ==Method== *POST ==Required Data Parameters== *{$objectid}: The ..."</p>
<hr />
<div>The [[Solution|solution]] order edit VM node command <br />
==Path==<br />
*/solution/order/editvmnode<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$objectid}: The ID of the object being edited. The object ID can be retrieved from Solution Order View -> objects.<br />
*{$services}: A [[glossary#JSON|JSON]] encoded array with all the services to be included with order.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[solutionid] => The ID of the solution.<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_ViewSolution Order View2012-06-03T20:11:54Z<p>Jcohen: /* Returned Data */</p>
<hr />
<div>The [[Solution|solution]] order view command returns details about an order.<br />
==Path==<br />
*/solution/order/view/{$orderid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$orderid}: The order ID that is returned when using the [[Solution Order List|solution order list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[id] => The ID of the order<br />
[solutionid] => The ID of the solution<br />
[total] => The total cost of the order.<br />
[status] => The status of the order.<br />
[created] => The time order was created (unix timestamp).<br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => <br />
[status] => The status of the of the <br />
[type] => The type of <br />
[name] => <br />
[details] => stdClass Object(<br />
[order] => stdClass Object(<br />
[id] => <br />
[planid] => <br />
[cloud_id] => <br />
[os_id] => The ID of the operating system.<br />
[storage_backend] => The type of hard drive used.<br />
[hostname] => The hostname of the server being deployed.<br />
[cpus] => The number of CPUs.<br />
[disk] => The amount of storage.<br />
[memory] => The amount of RAM.<br />
[total] => The total cost of the server.<br />
[createdon] => The time the server was created (unix timestamp).<br />
[datacenter] => The datacenter the server was deployed in.<br />
[osname] => The name of the operating system used.<br />
)<br />
[services] => An array of services that have been included with the order.<br />
)<br />
)<br />
)<br />
[time] => <br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=GlossaryGlossary2012-06-03T19:58:19Z<p>Jcohen: </p>
<hr />
<div>==API==<br />
An Application Programming Interface (API) is a source code-based specification intended to be used as an interface by software components to communicate with each other. An API may include specifications for routines, data structures, object classes, and variables. An API specification can take many forms, including an International Standard such as POSIX or vendor documentation such as the Microsoft Windows API, or the libraries of a programming language, e.g. Standard Template Library in C++ or Java API.<br />
<br />
==Canopy Storage==<br />
<br />
<br />
==CVV2==<br />
The Card Verification Value (CVV or CVV2), card security code (CSC), sometimes called Card Verification Data (CVD), Card Verification Value Code (CVVC), Card Verification Code (CVC or CVC2), Verification Code (V-Code or V Code), or Card Code Verification (CCV) are different terms for security features for credit or debit card transactions, providing increased protection against credit card fraud.<br />
<br />
==GET==<br />
Requests a representation of the specified resource. Requests using GET should only retrieve data and should have no other effect. (This is also true of some other HTTP methods.) The W3C has published guidance principles on this distinction, saying, "Web application design should be informed by the above principles, but also by the relevant limitations." See safe methods below.<br />
<br />
==FQDN==<br />
<br />
<br />
==LEAP==<br />
<br />
<br />
==JSON==<br />
<br />
<br />
==PDF==<br />
Portable Document Format (PDF) is an open standard for document exchange. This file format, created by [http://en.wikipedia.org/wiki/Adobe_Systems Adobe Systems] in 1993, is used for representing documents in a manner independent of application software, hardware, and operating systems. Each PDF file encapsulates a complete description of a fixed-layout flat document, including the text, fonts, graphics, and other information needed to display it.<br />
<br />
==POST==<br />
Submits data to be processed (e.g., from an HTML form) to the identified resource. The data is included in the body of the request. This may result in the creation of a new resource or the updates of existing resources or both.<br />
<br />
==Provision==<br />
When any servers status is set to "Provisioning", what this means is that the server is currently being setup and installed with all the data, software and to make it ready for network operation.<br />
<br />
==RDNS==<br />
<br />
<br />
==SingleHop==<br />
<br />
<br />
==Sub Account==<br />
<br />
<br />
==Virtual Machine==<br />
The term Virtual Machine is used to refer to either a [[servers#Private Cloud|private]] or [[servers#Public Cloud|public]] cloud server.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_Check_HostnameSolution Order Check Hostname2012-06-03T19:58:02Z<p>Jcohen: Created page with "The solution order check hostname command ==Path== */solution/order/checkhostname ==Method== *POST ==Required Data Parameters== *{$hostname}:..."</p>
<hr />
<div>The [[Solution|solution]] order check hostname command <br />
==Path==<br />
*/solution/order/checkhostname<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$hostname}: A [[glossary#FQDN|FQDN]] that is checked against the [[glossary#SingleHop|SingleHop]] database.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_ViewSolution Order View2012-06-03T19:41:03Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] order view command returns details about an order.<br />
==Path==<br />
*/solution/order/view/{$orderid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$orderid}: The order ID that is returned when using the [[Solution Order List|solution order list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[id] => The ID of the order<br />
[solutionid] => The ID of the solution<br />
[total] => The total cost of the order.<br />
[status] => The status of the order.<br />
[created] => The time order was created (unix timestamp).<br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => 1699<br />
[status] => The status of the of the <br />
[type] => The type of <br />
[name] => <br />
[details] => stdClass Object(<br />
[order] => stdClass Object(<br />
[id] => <br />
[planid] => <br />
[cloud_id] => <br />
[os_id] => The ID of the operating system.<br />
[storage_backend] => The type of hard drive used.<br />
[hostname] => The hostname of the server being deployed.<br />
[cpus] => The number of CPUs.<br />
[disk] => The amount of storage.<br />
[memory] => The amount of RAM.<br />
[total] => The total cost of the server.<br />
[createdon] => The time the server was created (unix timestamp).<br />
[datacenter] => The datacenter the server was deployed in.<br />
[osname] => The name of the operating system used.<br />
)<br />
[services] => An array of services that have been included with the order.<br />
)<br />
)<br />
)<br />
[time] => <br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_ViewSolution Order View2012-06-03T19:40:47Z<p>Jcohen: Created page with "The solution order view command returns details about the order. ==Path== */solution/order/view/{$orderid} ==Method== *GET ==Required Data Para..."</p>
<hr />
<div>The [[Solution|solution]] order view command returns details about the order.<br />
==Path==<br />
*/solution/order/view/{$orderid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$orderid}: The order ID that is returned when using the [[Solution Order List|solution order list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[id] => The ID of the order<br />
[solutionid] => The ID of the solution<br />
[total] => The total cost of the order.<br />
[status] => The status of the order.<br />
[created] => The time order was created (unix timestamp).<br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => 1699<br />
[status] => The status of the of the <br />
[type] => The type of <br />
[name] => <br />
[details] => stdClass Object(<br />
[order] => stdClass Object(<br />
[id] => <br />
[planid] => <br />
[cloud_id] => <br />
[os_id] => The ID of the operating system.<br />
[storage_backend] => The type of hard drive used.<br />
[hostname] => The hostname of the server being deployed.<br />
[cpus] => The number of CPUs.<br />
[disk] => The amount of storage.<br />
[memory] => The amount of RAM.<br />
[total] => The total cost of the server.<br />
[createdon] => The time the server was created (unix timestamp).<br />
[datacenter] => The datacenter the server was deployed in.<br />
[osname] => The name of the operating system used.<br />
)<br />
[services] => An array of services that have been included with the order.<br />
)<br />
)<br />
)<br />
[time] => <br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Order_ListSolution Order List2012-06-03T19:29:35Z<p>Jcohen: Created page with "The solution order list command returns a list of all the completed orders. ==Path== */solution/order/list ==Method== *GET ==Required Data Para..."</p>
<hr />
<div>The [[Solution|solution]] order list command returns a list of all the completed orders.<br />
==Path==<br />
*/solution/order/list<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[0] => stdClass Object(<br />
[id] => The ID of the order.<br />
[status] => The status of the order.<br />
[createdon] => The time order was created (unix timestamp).<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Services_ListSolution Services List2012-06-03T19:20:31Z<p>Jcohen: Created page with "The solution services list command ==Path== */solution/services/list ==Method== *GET ==Required Data Parameters== *None ==Optional Data Param..."</p>
<hr />
<div>The [[Solution|solution]] services list command <br />
==Path==<br />
*/solution/services/list<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[TYPE_OF_SERVICE] => Array(<br />
[0] => stdClass Object(<br />
[id] => The service ID<br />
[planid] => 617<br />
[name] => The name of the service.<br />
[unique] => If the service is unique (TRUE, FALSE).<br />
[mandatory] => If the service is mandatory (TRUE, FALSE).<br />
[primarytype] => The primaray type of service.<br />
[secondarytype] => The secondary type of service.<br />
[price] => The cost of the service.<br />
)<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_VMs_List_OSSolution VMs List OS2012-06-03T19:15:32Z<p>Jcohen: Created page with "The solution VMs list OS command ==Path== */solution/vms/listos ==Method== *GET ==Required Data Parameters== *None ==Optional Data Parameters..."</p>
<hr />
<div>The [[Solution|solution]] VMs list OS command <br />
==Path==<br />
*/solution/vms/listos<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => Array(<br />
[0] => stdClass Object(<br />
[id] => The operating system ID.<br />
[name] => The name of the operating system<br />
[arch] => The operating system architecture (i386, amd64)<br />
[os] => The type of operating system.<br />
[cpanel] => If the operating system includes cPanel (TRUE, FALSE).<br />
[custom] => If the operating system is a snapshot (TRUE, FALSE).<br />
[price] => The price of the operating system.<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_CloneSolution Clone2012-06-03T19:14:20Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] clone command allows a solution to be cloned into a new order.<br />
==Path==<br />
*/solution/clone<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
*{$hostnames}: A [[glossary#JOSN|JOSN]] encoded array that matches the old hostname to a new hostname {"OLD_HOSTNAME1":"NEW_HOSTNAME1", "OLD_HOSTNAME2":"NEW_HOSTNAME2"}.<br />
<br />
==Optional Data Parameters==<br />
*{$name}: The name of the person cloning the solution.<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_ReviewSolution Review2012-06-03T19:14:10Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] review command allows a user to review a crowd sourced solution.<br />
==Path==<br />
*/solution/review<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
*{$rating}: The rating that being given to the solution, (1-5).<br />
*{$comment}: A comment that will be submitted with the review.<br />
<br />
==Optional Data Parameters==<br />
*{$name}: The name of the person making the comment, default is Anonymous.<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_DeleteSolution Delete2012-06-03T19:13:44Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] delete command will delete a solution.<br />
==Path==<br />
*/solution/delete/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_AddSolution Add2012-06-03T19:13:23Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] add command is using to associate and existing component to a solution.<br />
==Path==<br />
*/solution/add<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
*{$type}: The type of component (vmnode, server, privatevm, publicvm).<br />
*{$typeid}: The ID of the component from the [[Solution List Unused]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => The ID of the component in the solution.<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_EditSolution Edit2012-06-03T19:13:05Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] command <br />
==Path==<br />
*/solution/edit/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*{$difficulty}: .<br />
*{$exampleurls}: .<br />
*{$description}: .<br />
*{$documentation}: .<br />
*{$keywords}: .<br />
*{$required_software}: .<br />
*{$solution_architect}: .<br />
*{$architect_author}: .<br />
*{$architect_first_name}: .<br />
*{$architect_last_name}: .<br />
*{$architect_email}: .<br />
*{$architect_bio}: .<br />
*{$architect_twitter}: .<br />
*{$architect_linkedin}: .<br />
*{$architect_facebook}: .<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_ViewSolution View2012-06-03T19:12:42Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] view command <br />
==Path==<br />
*/solution/view/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[SOLUTION_ID] => stdClass Object(<br />
[id] => SOLUTION_ID<br />
[clientid] => client ID<br />
[name] => Solution name<br />
[status] => Solution status<br />
[servercount] => Number of servers in the solution.<br />
[devicecount] => Number of servers in the solution.<br />
[vmcount] => Number of virtual machines in the solution.<br />
[appcount] => <br />
[createdon] => Date the solution was created (unix timestamp).<br />
[description] => Description about the solution.<br />
[crowdstatus] => <br />
[reviewstars] => How many stars this solution has been rated.<br />
[reviewcount] => The number of reviews that have been done.<br />
[documentation] => Documentations details.<br />
[keywords] => Search keywords.<br />
[code] => <br />
[solution_architect] => <br />
[parentid] => <br />
[architect_first_name] => The first name of the solution architect.<br />
[architect_last_name] => The last name of the solution architect.<br />
[architect_email] => The email address of the solution architect.<br />
[architect_bio] => The bio of the solution architect.<br />
[architect_twitter] => The Twitter name of the solution architect.<br />
[architect_linkedin] => The LinkedIn name of the solution architect. <br />
[difficulty] => <br />
[exampleurls] => <br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => Component ID.<br />
[parentid] => <br />
[type] => Component type.<br />
[name] => Component hostname.<br />
[manageid] => Component ID used with server module commands.<br />
[os] => Component operating system.<br />
[status] => Component power status.<br />
[primaryip] => Component primary IP address.<br />
[created] => Component added time (formatted output).<br />
)<br />
)<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_RenameSolution Rename2012-06-03T19:12:24Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] rename command allows a solution to be renamed.<br />
==Path==<br />
*/solution/rename<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The solution ID that is returned when using the [[Solution List|list]] command.<br />
*{$name}: New solution name.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_EditSolution Edit2012-06-03T19:11:53Z<p>Jcohen: /* Required Data Parameters */</p>
<hr />
<div>The [[Solution|solution]] command <br />
==Path==<br />
*/solution/edit/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The server ID that is returned when using the [[Solution List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*{$difficulty}: .<br />
*{$exampleurls}: .<br />
*{$description}: .<br />
*{$documentation}: .<br />
*{$keywords}: .<br />
*{$required_software}: .<br />
*{$solution_architect}: .<br />
*{$architect_author}: .<br />
*{$architect_first_name}: .<br />
*{$architect_last_name}: .<br />
*{$architect_email}: .<br />
*{$architect_bio}: .<br />
*{$architect_twitter}: .<br />
*{$architect_linkedin}: .<br />
*{$architect_facebook}: .<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_ViewSolution View2012-06-03T19:11:47Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] view command <br />
==Path==<br />
*/solution/view/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The server ID that is returned when using the [[Solution List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[SOLUTION_ID] => stdClass Object(<br />
[id] => SOLUTION_ID<br />
[clientid] => client ID<br />
[name] => Solution name<br />
[status] => Solution status<br />
[servercount] => Number of servers in the solution.<br />
[devicecount] => Number of servers in the solution.<br />
[vmcount] => Number of virtual machines in the solution.<br />
[appcount] => <br />
[createdon] => Date the solution was created (unix timestamp).<br />
[description] => Description about the solution.<br />
[crowdstatus] => <br />
[reviewstars] => How many stars this solution has been rated.<br />
[reviewcount] => The number of reviews that have been done.<br />
[documentation] => Documentations details.<br />
[keywords] => Search keywords.<br />
[code] => <br />
[solution_architect] => <br />
[parentid] => <br />
[architect_first_name] => The first name of the solution architect.<br />
[architect_last_name] => The last name of the solution architect.<br />
[architect_email] => The email address of the solution architect.<br />
[architect_bio] => The bio of the solution architect.<br />
[architect_twitter] => The Twitter name of the solution architect.<br />
[architect_linkedin] => The LinkedIn name of the solution architect. <br />
[difficulty] => <br />
[exampleurls] => <br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => Component ID.<br />
[parentid] => <br />
[type] => Component type.<br />
[name] => Component hostname.<br />
[manageid] => Component ID used with server module commands.<br />
[os] => Component operating system.<br />
[status] => Component power status.<br />
[primaryip] => Component primary IP address.<br />
[created] => Component added time (formatted output).<br />
)<br />
)<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_ViewSolution View2012-06-03T19:10:18Z<p>Jcohen: /* Required Data Parameters */</p>
<hr />
<div>The [[Solution|solution]] view command <br />
==Path==<br />
*/solution/view/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The ID of the solution being viewed.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[SOLUTION_ID] => stdClass Object(<br />
[id] => SOLUTION_ID<br />
[clientid] => client ID<br />
[name] => Solution name<br />
[status] => Solution status<br />
[servercount] => Number of servers in the solution.<br />
[devicecount] => Number of servers in the solution.<br />
[vmcount] => Number of virtual machines in the solution.<br />
[appcount] => <br />
[createdon] => Date the solution was created (unix timestamp).<br />
[description] => Description about the solution.<br />
[crowdstatus] => <br />
[reviewstars] => How many stars this solution has been rated.<br />
[reviewcount] => The number of reviews that have been done.<br />
[documentation] => Documentations details.<br />
[keywords] => Search keywords.<br />
[code] => <br />
[solution_architect] => <br />
[parentid] => <br />
[architect_first_name] => The first name of the solution architect.<br />
[architect_last_name] => The last name of the solution architect.<br />
[architect_email] => The email address of the solution architect.<br />
[architect_bio] => The bio of the solution architect.<br />
[architect_twitter] => The Twitter name of the solution architect.<br />
[architect_linkedin] => The LinkedIn name of the solution architect. <br />
[difficulty] => <br />
[exampleurls] => <br />
[objects] => Array(<br />
[0] => stdClass Object(<br />
[id] => Component ID.<br />
[parentid] => <br />
[type] => Component type.<br />
[name] => Component hostname.<br />
[manageid] => Component ID used with server module commands.<br />
[os] => Component operating system.<br />
[status] => Component power status.<br />
[primaryip] => Component primary IP address.<br />
[created] => Component added time (formatted output).<br />
)<br />
)<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_ListSolution List2012-06-03T19:09:49Z<p>Jcohen: /* Optional Data Parameters */</p>
<hr />
<div>The [[Solution|solution]] list command <br />
==Path==<br />
*/solution/list/{$status}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*{$status}: The status of the solution, (pending, deployed).<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[SOLUTION_ID] => stdClass Object(<br />
[id] => SOLUTION_ID<br />
[clientid] => client ID<br />
[name] => Solution name<br />
[status] => Solution status<br />
[servercount] => Number of servers in the solution.<br />
[devicecount] => Number of servers in the solution.<br />
[vmcount] => Number of virtual machines in the solution.<br />
[appcount] => <br />
[createdon] => Date the solution was created (unix timestamp).<br />
[description] => Description about the solution.<br />
[crowdstatus] => <br />
[reviewstars] => How many stars this solution has been rated.<br />
[documentation] => Documentations details<br />
[keywords] => Search keywords.<br />
[code] => <br />
[architect_first_name] => The first name of the solution architect.<br />
[architect_last_name] => The last name of the solution architect.<br />
[architect_email] => The email address of the solution architect.<br />
[architect_bio] => The bio of the solution architect.<br />
[architect_twitter] => The Twitter name of the solution architect.<br />
[architect_linkedin] => The LinkedIn name of the solution architect.<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_VMs_Form_DetailsSolution VMs Form Details2012-06-03T19:06:44Z<p>Jcohen: Created page with "The solution VMs form details command returns ==Path== */solution/vms/formdetails/{$formid) ==Method== *GET ==Required Data Parameters== *{$fo..."</p>
<hr />
<div>The [[Solution|solution]] VMs form details command returns <br />
==Path==<br />
*/solution/vms/formdetails/{$formid)<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$formid): The form ID that is returned when using the [[Solution VMs List|solution VMs list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Servers_Form_DetailsSolution Servers Form Details2012-06-03T19:06:08Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] servers form details command returns <br />
==Path==<br />
*/solution/servers/formdetails/{$formid)<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$formid): The form ID that is returned when using the [[Solution Servers List|solution servers list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_VMs_ListSolution VMs List2012-06-03T19:03:21Z<p>Jcohen: Created page with "The solution VM list command returns a list of all the virtual machines that can be ordered from SingleHop. ==Path== */solution/vms/list =..."</p>
<hr />
<div>The [[Solution|solution]] VM list command returns a list of all the virtual machines that can be ordered from [[glossary#SingleHop|SingleHop]].<br />
==Path==<br />
*/solution/vms/list<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => Array(<br />
[0] => stdClass Object(<br />
[id] => The order form ID for the virtual machine.<br />
[name] => The name of the virtual machine.<br />
[type] => The type of virtual machine (publice, private).<br />
[price] => The price of the virtual machine.<br />
[vcpu] => The number of virtual CPUs included with the virtual machine.<br />
[storage] => The amount of hard drive space included with the virtual machine.<br />
[ram] => The amount of RAM included with the virtual machine.<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Servers_Form_DetailsSolution Servers Form Details2012-05-30T18:35:59Z<p>Jcohen: Created page with "The solution servers form details command returns ==Path== */solution/servers/formdetails/{$formid) ==Method== *GET ==Required Data Parameters..."</p>
<hr />
<div>The [[Solution|solution]] servers form details command returns <br />
==Path==<br />
*/solution/servers/formdetails/{$formid)<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$formid): .<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Servers_ListSolution Servers List2012-05-30T18:35:51Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] servers list command returns a list of all the servers that can be ordered from [[glossary#SingleHop|SingleHop]].<br />
==Path==<br />
*/solution/servers/list<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => Array(<br />
[0] => stdClass Object(<br />
[orderformid] => The order form ID for the server.<br />
[servercode] => The internal code of the server.<br />
[servername] => The name of the server.<br />
[servernameparts] => Server name parts.<br />
[cascade] => If the server is a Cascade server (TRUE/FALSE).<br />
[fullymanaged] => If the server includes management (TRUE/FALSE).<br />
[instock] => If the server is in stock (TRUE/FALSE).<br />
[datacenters] => If "instock" is TRUE, quantity available in data centers will be listed.<br />
[ram] => RAM included with the server.<br />
[ramparts] => RAM parts.<br />
[hd] => Hard drive included with the server.<br />
[hdparts] => Hard drive name parts.<br />
[bandwidth] => Bandwidth included with the server,<br />
[bandwidthparts] => Bandwidth parts.<br />
[price] => Price of the server.<br />
[retailprice] => Retail price of the server.<br />
[setupfee] => Setup fee for the server.<br />
[discount] => Discount applied to the price.<br />
[override] => Price overide.<br />
[tandemonly] => If the server is only available to Tandem resellers (TRUE/FALSE).<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Servers_ListSolution Servers List2012-05-30T16:45:17Z<p>Jcohen: Created page with "The solution servers list command ==Path== */solution/servers/list ==Method== *GET ==Required Data Parameters== *None ==Optional Data Paramet..."</p>
<hr />
<div>The [[Solution|solution]] servers list command <br />
==Path==<br />
*/solution/servers/list<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*None<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => Array(<br />
[0] => stdClass Object(<br />
[orderformid] => The order form ID for the server.<br />
[servercode] => The internal code of the server.<br />
[servername] => The name of the server.<br />
[servernameparts] => Server name parts.<br />
[cascade] => If the server is a Cascade server (TRUE/FALSE).<br />
[fullymanaged] => If the server includes management (TRUE/FALSE).<br />
[instock] => If the server is in stock (TRUE/FALSE).<br />
[datacenters] => If "instock" is TRUE, quantity available in data centers will be listed.<br />
[ram] => RAM included with the server.<br />
[ramparts] => RAM parts.<br />
[hd] => Hard drive included with the server.<br />
[hdparts] => Hard drive name parts.<br />
[bandwidth] => Bandwidth included with the server,<br />
[bandwidthparts] => Bandwidth parts.<br />
[price] => Price of the server.<br />
[retailprice] => Retail price of the server.<br />
[setupfee] => Setup fee for the server.<br />
[discount] => Discount applied to the price.<br />
[override] => Price overide.<br />
[tandemonly] => If the server is only available to Tandem resellers (TRUE/FALSE).<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Pending_DeploySolution Pending Deploy2012-05-30T16:20:25Z<p>Jcohen: Created page with "The solution pending deploy command ==Path== */solution/pending/deploy/{$solutionid} ==Method== *GET ==Required Data Parameters== *{$solutioni..."</p>
<hr />
<div>The [[Solution|solution]] pending deploy command <br />
==Path==<br />
*/solution/pending/deploy/{$solutionid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The ID of the solution that is being deployed.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => The solution ID.<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Pending_AddSolution Pending Add2012-05-30T16:19:51Z<p>Jcohen: </p>
<hr />
<div>The [[Solution|solution]] pending add command <br />
==Path==<br />
*/solution/pending/add<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{$solutionid}: The ID of the solution a component is being added to.<br />
*{$type}: The type of component (server, vmnode, publicvm, privatevm).<br />
*{$typeid}: The ID of the component, must not already be in a solution.<br />
*{$hostname}: The hostname of the component.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => The solution ID.<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Solution_Pending_AddSolution Pending Add2012-05-30T16:11:14Z<p>Jcohen: Created page with "The solution pending add command ==Path== */solution/pending/add ==Method== *POST ==Required Data Parameters== *{solutionid}: The ID of the s..."</p>
<hr />
<div>The [[Solution|solution]] pending add command <br />
==Path==<br />
*/solution/pending/add<br />
<br />
==Method==<br />
*[[glossary#POST|POST]]<br />
<br />
==Required Data Parameters==<br />
*{solutionid}: The ID of the solution a component is being added to.<br />
*{type}: The type of component (server, vmnode, publicvm, privatevm).<br />
*{typeid}: The ID of the component, must not already be in a solution.<br />
*{hostname}: The hostname of the component.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => The solution ID.<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Server_BandwidthServer Bandwidth2012-05-16T17:02:42Z<p>Jcohen: </p>
<hr />
<div>The [[Server|server]] bandwidth command will return a list the bandwidth usage for a server for a specified period. When this command is run it may take a few minutes for it to finish.<br />
==Path==<br />
*/server/bandwidth/{$start}/{$end}/{$serverid}<br />
<br />
==Method==<br />
*[[glossary#GET|GET]]<br />
<br />
==Availability==<br />
*[[servers#Dedicated Server|Dedicated Server]]<br />
*[[servers#Dynamic Server|Dynamic Server]]<br />
*[[servers#Private Cloud|Private Cloud]]<br />
*[[servers#Public Cloud|Public Cloud]]<br />
<br />
==Required Data Parameters==<br />
*{$start}: The start date and time of the bandwidth records to be retrieved (unix timestamp).<br />
*{$end}: The end date and time of the bandwidth records to be retrieved (unix timestamp).<br />
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.<br />
<br />
==Optional Data Parameters==<br />
*None<br />
<br />
==Returned Data==<br />
<pre><br />
stdClass Object(<br />
[success] => TRUE/FALSE<br />
[data] => stdClass Object(<br />
[intotal] => The total inbound bandwidth used for the specified start/end time.<br />
[outtotal] => The total outbound bandwidth used for the specified start/end time.<br />
[dailyusage] => array(<br />
[0] => stdClass Object(<br />
[in] => Inbound bandwidth used on a specific date.<br />
[out] => Outbound bandwidth used on a specific date.<br />
[timestamp] => The date the bandwidth usage was retrieved (unix timestamp).<br />
[date] => The date the bandwidth usage was retrieved (human readable).<br />
)<br />
)<br />
)<br />
)<br />
</pre></div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=Main_PageMain Page2012-05-14T21:38:23Z<p>Jcohen: </p>
<hr />
<div>== Welcome to SingleHop's Dropzone API Wiki ==<br />
<br />
[[glossary#SingleHop|SingleHop]] offers a [[glossary#API|Application Programming Interface (API)]] for [[glossary#LEAP|LEAP]]. We created these [[glossary#API|APIs]] so that our customers could build applications that can interact and exchange data with the [[glossary#SingleHop|SingleHop's]] server management, ticketing and billing systems. You can use our [[glossary#API|API]] to create internal tools that can manage your account data, open support tickets, and manage your servers. If you represent a company that resells hosting services you can use our [[glossary#API|API]] to build a portal that your own customers can use to access and maintain their accounts.<br />
<br />
<br />
The [[glossary#LEAP|LEAP]] [[glossary#API|API]] consists of 8 modules that can be accessed.<br />
#[[Billing]]<br />
#[[Order]]<br />
#[[Server]]<br />
#[[Service]]<br />
#[[Solution]]<br />
#[[Support]]<br />
#[[Tandem]]<br />
#[[User]]<br />
<br />
<br />
Instructions on how to access the Dropzone [[glossary#API|API]] can be found on the [[API Basics]] page.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=UserUser2012-05-14T21:28:28Z<p>Jcohen: </p>
<hr />
<div>==User Commands==<br />
*[[User Team]]: Lists the SingleHop team members assigned to an account..<br />
*[[User List]]: Lists all the [[glossary#Sub Account|sub accounts]] that have been added on the [[glossary#LEAP|LEAP]] account.<br />
*[[User Create]]: Creates a new user in [[glossary#LEAP|LEAP]].<br />
*[[User Edit]]: Edits a user in [[glossary#LEAP|LEAP]].<br />
*[[User Contacts]]: Lists all the contacts on a [[glossary#LEAP|LEAP]] account.<br />
*[[User View]]: List the details about the primary account holder.<br />
*[[User Delete]]: Deletes a [[glossary#Sub Account|sub account]] from [[glossary#LEAP|LEAP]].<br />
*[[User Permission]]: Retrieve or update the permissions for a [[glossary#Sub Account|sub account]].<br />
*[[User Add Component]]: Allows a [[glossary#Sub Account|sub account]] access to a server.<br />
*[[User Permission Types]]: Lists all the permissions that can be added to a [[glossary#Sub Account|sub account]].<br />
*[[User Log]]: Lists all the actions that have been done on the [[glossary#LEAP|LEAP]] account.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=TandemTandem2012-05-14T21:28:10Z<p>Jcohen: </p>
<hr />
<div>The Tandem module allows a Tandem reseller to manage users, edit settings, handle ticketing and view statistics. This [[glossary#API|API]] is only available to tandem users and will throw a permissions error for none tandem accounts.<br />
<br />
==Tandem Commands==<br />
*[[Tandem Tandem]]: Returns a welcome message and Tandem account details.<br />
<br />
===Tandem Stats===<br />
*[[Tandem Stats Logs]]: .<br />
*[[Tandem Stats Ticket]]: .<br />
*[[Tandem Stats Sales]]: .<br />
*[[Tandem Stats Tandem]]: .<br />
===Tandem Settings===<br />
*[[Tandem Settings List]]: .<br />
*[[Tandem Settings Edit]]: .<br />
*[[Tandem Settings Services]]: .<br />
*[[Tandem Settings Discounts]]: .<br />
===Tandem User===<br />
*[[Tandem User List]]: .<br />
*[[Tandem User Edit]]: .<br />
*[[Tandem User Add]]: .<br />
*[[Tandem User Add Component]]: .<br />
*[[Tandem User Delete]]: .<br />
*[[Tandem User Delete Component]]: .<br />
===Tandem Support===<br />
*[[Tandem Support]]: .<br />
*[[Tandem Support List]]: .<br />
*[[Tandem Support View]]: .<br />
*[[Tandem Support Reply]]: .<br />
*[[Tandem Support Close]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=BillingBilling2012-05-14T21:27:36Z<p>Jcohen: </p>
<hr />
<div>The Billing module lets you list, view and pay for invoices. It also allows you to list, add and edit payment methods. <br />
<br />
==Billing Commands==<br />
*[[Billing List]]: List invoices.<br />
*[[Billing View]]: View invoice details.<br />
*[[Billing Credits]]: View account credits.<br />
*[[Billing View PDF]]: Retrieves the raw PDF code for a specific invoice.<br />
*[[Billing Payment Methods]]: View current payment methods added on the account..<br />
*[[Billing Edit Payment Methods]]: Edit current payment methods on the account..<br />
*[[Billing Delete Payment Method]]: Delete an added payment method.<br />
*[[Billing Set Default Payment Method]]: Set the default payment method.<br />
*[[Billing Pay]]: Pay an unpaid invoice.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=BillingBilling2012-05-14T21:27:19Z<p>Jcohen: </p>
<hr />
<div>The Billing module lets you list, view and pay for invoices. It also allows you to list, add and edit payment methods. The list function works similarly to how the support modules list works, you may pass it a type (paid, unpaid, disregarded and all) and change it’s start and limit.<br />
<br />
==Billing Commands==<br />
*[[Billing List]]: List invoices.<br />
*[[Billing View]]: View invoice details.<br />
*[[Billing Credits]]: View account credits.<br />
*[[Billing View PDF]]: Retrieves the raw PDF code for a specific invoice.<br />
*[[Billing Payment Methods]]: View current payment methods added on the account..<br />
*[[Billing Edit Payment Methods]]: Edit current payment methods on the account..<br />
*[[Billing Delete Payment Method]]: Delete an added payment method.<br />
*[[Billing Set Default Payment Method]]: Set the default payment method.<br />
*[[Billing Pay]]: Pay an unpaid invoice.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=SolutionSolution2012-05-14T21:26:53Z<p>Jcohen: </p>
<hr />
<div>==Solution Commands==<br />
*[[Solution List]]: .<br />
*[[Solution Review]]: .<br />
*[[Solution Clone]]: .<br />
*[[Solution List Unused]]: .<br />
*[[Solution View]]: .<br />
*[[Solution Deploying]]: .<br />
*[[Solution Edit]]: .<br />
*[[Solution Create]]: .<br />
*[[Solution Rename]]: .<br />
*[[Solution Add]]: .<br />
*[[Solution Delete Object]]: .<br />
*[[Solution Delete]]: .<br />
===Solution Pending===<br />
*[[Solution Pending Add]]: . <br />
*[[Solution Pending Deploy]]: .<br />
===Solution Servers===<br />
*[[Solution Servers List]]: .<br />
*[[Solution Servers Form Details]]: .<br />
===Solution VMs===<br />
*[[Solution VMs List]]: .<br />
*[[Solution VMs Form Details]]: .<br />
*[[Solution VMs List OS]]: .<br />
===Solution Services===<br />
*[[Solution Services List]]: .<br />
===Solution Order===<br />
*[[Solution Order List]]: .<br />
*[[Solution Order View]]: .<br />
*[[Solution Order Object]]: .<br />
*[[Solution Order Create]]: .<br />
*[[Solution Order Add]]: .<br />
*[[Solution Order Delete]]: .<br />
*[[Solution Order Check Hostname]]: .<br />
*[[Solution Order Edit VM Node]]: .<br />
*[[Solution Order Edit Server]]: .<br />
*[[Solution Order Edit Public VM]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=SolutionSolution2012-05-14T21:26:23Z<p>Jcohen: </p>
<hr />
<div><br />
<br />
==Solution Commands==<br />
*[[Solution List]]: .<br />
*[[Solution Review]]: .<br />
*[[Solution Clone]]: .<br />
*[[Solution List Unused]]: .<br />
*[[Solution View]]: .<br />
*[[Solution Deploying]]: .<br />
*[[Solution Edit]]: .<br />
*[[Solution Create]]: .<br />
*[[Solution Rename]]: .<br />
*[[Solution Add]]: .<br />
*[[Solution Delete Object]]: .<br />
*[[Solution Delete]]: .<br />
==Solution Pending==<br />
*[[Solution Pending Add]]: . <br />
*[[Solution Pending Deploy]]: .<br />
==Solution Servers==<br />
*[[Solution Servers List]]: .<br />
*[[Solution Servers Form Details]]: .<br />
==Solution VMs==<br />
*[[Solution VMs List]]: .<br />
*[[Solution VMs Form Details]]: .<br />
*[[Solution VMs List OS]]: .<br />
==Solution Services==<br />
*[[Solution Services List]]: .<br />
==Solution Order==<br />
*[[Solution Order List]]: .<br />
*[[Solution Order View]]: .<br />
*[[Solution Order Object]]: .<br />
*[[Solution Order Create]]: .<br />
*[[Solution Order Add]]: .<br />
*[[Solution Order Delete]]: .<br />
*[[Solution Order Check Hostname]]: .<br />
*[[Solution Order Edit VM Node]]: .<br />
*[[Solution Order Edit Server]]: .<br />
*[[Solution Order Edit Public VM]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=SupportSupport2012-05-14T21:26:14Z<p>Jcohen: </p>
<hr />
<div>The Support module allows you to interact with the [[glossary#SingleHop|SingleHop]] support ticketing system. You may do things like list tickets, search through tickets, create new tickets and reply to tickets.<br />
<br />
==Support Commands==<br />
*[[Support List]]: Lists all support tickets, open and closed.<br />
*[[Support Departments]]: Returns a count of all open and closed tickets by department.<br />
*[[Support List New]]: List the last 5 opened tickets.<br />
*[[Support View]]: View the details about a specific support ticket.<br />
*[[Support Ticket Types]]: List all of the valid fields that are used with the [[Support Create|create]] function.<br />
*[[Support Create]]: .<br />
*[[Support Close]]: Used to close tickets.<br />
*[[Support Reply]]: Used to post a reply to an already created ticket.</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=ServiceService2012-05-14T21:22:20Z<p>Jcohen: </p>
<hr />
<div>This Service module allows you to view which services a server posses and also purchase them. Beyond this it also allows you to see which Servers we have, if they are in stock and also get a one time URL that allows you to go to an order form in an already signed in state. There is also a licensing component to this API that allows the purchasing of cPanel licenses.<br />
<br />
==Service Commands==<br />
*[[Service License]]: Lists all available licenses that can be purchased for your [[SingleHop]] servers.<br />
**[[Service License List]]: .<br />
**[[Service License Purchase]]: .<br />
**[[Service License Delete]]: .<br />
*[[Service List]]: .<br />
*[[Service Purchase]]: .<br />
*[[Service Servers]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=OrderOrder2012-05-14T21:21:59Z<p>Jcohen: </p>
<hr />
<div>==Order Commands==<br />
*[[Order List]]: List all available servers for order.<br />
*[[Order Form Details]]: List all the form options required to order a server.<br />
*[[Order Create]]: .<br />
*[[Order Edit]]: .<br />
*[[Order Details]]: .<br />
*[[Order Submit]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=TandemTandem2012-05-14T21:21:41Z<p>Jcohen: </p>
<hr />
<div>The Tandem module allows a Tandem reseller to manage users, edit settings, handle ticketing and view statistics. This [[glossary#API|API]] is only available to tandem users and will throw a permissions error for none tandem accounts.<br />
<br />
==Tandem==<br />
*[[Tandem Tandem]]: Returns a welcome message and Tandem account details.<br />
<br />
==Tandem Stats==<br />
*[[Tandem Stats Logs]]: .<br />
*[[Tandem Stats Ticket]]: .<br />
*[[Tandem Stats Sales]]: .<br />
*[[Tandem Stats Tandem]]: .<br />
==Tandem Settings==<br />
*[[Tandem Settings List]]: .<br />
*[[Tandem Settings Edit]]: .<br />
*[[Tandem Settings Services]]: .<br />
*[[Tandem Settings Discounts]]: .<br />
==Tandem User==<br />
*[[Tandem User List]]: .<br />
*[[Tandem User Edit]]: .<br />
*[[Tandem User Add]]: .<br />
*[[Tandem User Add Component]]: .<br />
*[[Tandem User Delete]]: .<br />
*[[Tandem User Delete Component]]: .<br />
==Tandem Support==<br />
*[[Tandem Support]]: .<br />
*[[Tandem Support List]]: .<br />
*[[Tandem Support View]]: .<br />
*[[Tandem Support Reply]]: .<br />
*[[Tandem Support Close]]: .</div>Jcohenhttp://dropzonewiki.singlehop.com/index.php?title=AffiliateAffiliate2012-05-14T21:21:24Z<p>Jcohen: </p>
<hr />
<div>==Affiliate Commands==<br />
*[[Affiliate Get Settings]]: .<br />
*[[Affiliate Set Settings]]: .<br />
*[[Affiliate Stats]]: .<br />
*[[Affiliate Paid]]: .<br />
*[[Affiliate Unpaid]]: .<br />
*[[Affiliate Unvalidated]]: .</div>Jcohen