Server/Cloud Bailout

From INAP Dropzone API
(Difference between revisions)
Jump to: navigation, search
(Optional Data Parameters)
(Required Data Parameters)
 
(2 intermediate revisions by one user not shown)
Line 4: Line 4:
  
 
==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.
 
*{$serverid}: The server ID that is returned when using the [[Server List|list]] command.
*{$action}: The action to perform (either starting or stopping Bailout). Only required when starting Bailout.
+
*{$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==

Latest revision as of 16:43, 3 January 2020

The server bailout command will boot a dedicated server or a virtual machine into bailout mode or bring it back into regular mode.

Contents

Path

  • /server/bailout/{$action}/{$serverid}

Method

Availability

Required Data Parameters

  • {$serverid}: The server ID that is returned when using the list command.
  • {$action}: The action to perform (either start or stop Bailout). Only required when starting Bailout.
  • {$pin}: Account PIN number

Optional Data Parameters

  • {$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

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