(→Optional Data Parameters) |
|||
(3 intermediate revisions by one user not shown) | |||
Line 1: | Line 1: | ||
− | The check install command will return the step name and progress percentage of a [[Dedicated Server]], [[Dynamic Server]] or [[Virtual Machine|virtual | + | 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} | ||
==Method== | ==Method== | ||
− | *GET | + | *[[glossary#get|GET]] |
==Availability== | ==Availability== | ||
− | *[[Dedicated Server]] | + | *[[servers#Dedicated Server|Dedicated Server]] |
− | *[[Dynamic Server]] | + | *[[servers#Dynamic Server|Dynamic Server]] |
− | *[[Private Cloud]] | + | *[[servers#Private Cloud|Private Cloud]] |
− | *[[Public Cloud]] | + | *[[servers#Public Cloud|Public Cloud]] |
==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== |
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 |
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. ) )