Server Cancel

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Created page with "The server check install command will return the step name and progress percentage of a Dedicated Server, [[servers#Dynamic Server|Dyna...")
 
 
Line 1: Line 1:
The [[Server|server]] check install command will return the step name and progress percentage of a [[servers#Dedicated Server|Dedicated Server]], [[servers#Dynamic Server|Dynamic Server]] or [[servers#Virtual Machine|virtual machines]] that is currently being [[glossary#provision|provisioned]].
+
The [[Server|server]] cancel command will create a cancellation request for the hostname specified.
 
==Path==
 
==Path==
*/server/checkinstall/{$serverid}
+
*/server/cancel/{$hostname}
  
 
==Method==
 
==Method==
*[[glossary#get|GET]]
+
*[[glossary#post|POST]]
  
 
==Availability==
 
==Availability==
Line 13: Line 13:
  
 
==Required Data Parameters==
 
==Required Data Parameters==
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.
+
*{$hostname}: The hostname that is returned when using the [[Server List|list]] command.
  
 
==Optional Data Parameters==
 
==Optional Data Parameters==
Line 22: Line 22:
 
stdClass Object(
 
stdClass Object(
 
   [success] => TRUE/FALSE
 
   [success] => TRUE/FALSE
   [data] => stdClass Object(
+
   [data] => Cancelation ID
    [step] => Step  the server setup is on.
+
    [progress] => Progress percentage
+
    [position] => Step number the server setup is on.
+
    [steps] => An object listing all the steps, varies between server type.
+
  )
+
 
)
 
)
 
</pre>
 
</pre>

Latest revision as of 16:00, 27 March 2014

The server cancel command will create a cancellation request for the hostname specified.

Contents

Path

  • /server/cancel/{$hostname}

Method

Availability

Required Data Parameters

  • {$hostname}: The hostname that is returned when using the list command.

Optional Data Parameters

  • None

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => Cancelation ID
)
Personal tools