m (moved Server Bailout to Server/Cloud Bailout) |
(→Required Data Parameters) |
||
(8 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
The [[Server|server]] bailout command will boot a [[servers#Dedicated Server|dedicated server]] or a [[glossary#Virtual Machine|virtual machine]] into bailout mode or bring it back into regular mode. | The [[Server|server]] bailout command will boot a [[servers#Dedicated Server|dedicated server]] or a [[glossary#Virtual Machine|virtual machine]] into bailout mode or bring it back into regular mode. | ||
==Path== | ==Path== | ||
− | */server/bailout/{$ | + | */server/bailout/{$action}/{$serverid} |
==Method== | ==Method== | ||
− | *[[glossary# | + | *[[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. | *{$serverid}: The server ID that is returned when using the [[Server List|list]] command. | ||
+ | *{$action}: The action to perform (either start or stop Bailout). Only required when starting Bailout. | ||
+ | *{$pin}: Account PIN number | ||
==Optional Data Parameters== | ==Optional Data Parameters== | ||
− | *{$action}: Allows for the bailout mode to be started or stopped, start or stop can be used. | + | *{$action}: Allows for the bailout mode to be started or stopped, start or stop can be used. If no value is passed, stop is assumed. |
==Returned Data== | ==Returned Data== |
The server bailout command will boot a dedicated server or a virtual machine into bailout mode or bring it back into regular mode.
Contents |
stdClass Object( [success] => TRUE/FALSE )