Server Check Install

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
 
Line 1: Line 1:
The [[Server|server]] check install command will return the step name and progress percentage of a [[Dedicated Server]], [[Dynamic Server]] or [[Virtual Machine|virtual machine]] that is currently being [[glossary#provision|provisioned]].
+
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]].
 
==Path==
 
==Path==
 
*/server/checkinstall/{$serverid}
 
*/server/checkinstall/{$serverid}
Line 13: Line 13:
  
 
==Required Data Parameters==
 
==Required Data Parameters==
*{$serverid}
+
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.
  
 
==Optional Data Parameters==
 
==Optional Data Parameters==

Latest revision as of 23:08, 24 March 2012

The server check install command will return the step name and progress percentage of a Dedicated Server, Dynamic Server or virtual machines that is currently being provisioned.

Contents

Path

  • /server/checkinstall/{$serverid}

Method

Availability

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.

Optional Data Parameters

  • None

Returned Data

stdClass Object(
  [success] => TRUE/FALSE
  [data] => stdClass Object(
    [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.
  )
)
Personal tools