ServerActionReboot

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision: Release 86)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=='''POST''' /servers/'''id'''/action==
 
 
The reboot action allows for either a soft or hard reboot of a [[Server]]. With a soft reboot (SOFT), the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot (HARD) is the equivalent of power cycling the server.
 
The reboot action allows for either a soft or hard reboot of a [[Server]]. With a soft reboot (SOFT), the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot (HARD) is the equivalent of power cycling the server.
  
=== Parameters ===
+
='''POST''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/action=
 +
 
 +
== Parameters ==
 +
; accountId - ''string''
 +
: The selected account Id.
 +
 
 
; id
 
; id
 
: The unique identifier of the server to reboot.
 
: The unique identifier of the server to reboot.
  
==== JSON ====
+
=== JSON ===
 
  <nowiki>
 
  <nowiki>
 
{
 
{
Line 18: Line 22:
 
: Type of reboot to perform. Values: '''HARD''', '''SOFT'''.
 
: Type of reboot to perform. Values: '''HARD''', '''SOFT'''.
  
=== Response Codes ===
+
== Response Codes ==
 
; Success:  
 
; Success:  
 
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.
 
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.
Line 29: Line 33:
 
: ''HTTP/1.1 409 Conflict'' : Already rebooting.
 
: ''HTTP/1.1 409 Conflict'' : Already rebooting.
  
[[Category:Hostway API]]
+
== Alternative URI /servers/{id}/action ==
[[Category:FlexCloud Server API]]
+
An alternative way to execute this call is to omit the ''accountId'' portion of the URI. In this case the system assumes the request is executed for the account identified in the [[Authentication|authorization header]].
  
<!--  THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->
+
<code>POST /servers/{id}/action</code>
  
{{#widget:DISQUS
+
[[Category:Hostway API]]
|id=hostway
+
[[Category:FlexCloud Server API]]
|uniqid={{PAGENAME}}
+
|url={{fullurl:{{PAGENAME}}}}
+
}}
+
 
+
<!--  ########################################################################### -->
+

Latest revision as of 12:00, 11 October 2013

The reboot action allows for either a soft or hard reboot of a Server. With a soft reboot (SOFT), the operating system is signaled to restart, which allows for a graceful shutdown of all processes. A hard reboot (HARD) is the equivalent of power cycling the server.

Contents

[edit] POST /accounts/{accountId}/flexcloud/servers/{id}/action

[edit] Parameters

accountId - string
The selected account Id.
id
The unique identifier of the server to reboot.

[edit] JSON

{
   "reboot":
      {
         "type": "HARD"
      }
}
type - string
Type of reboot to perform. Values: HARD, SOFT.

[edit] Response Codes

Success
HTTP/1.1 202 Accepted : The request is accepted for processing.
Failure
HTTP/1.1 400 Bad Request : Check your parameter. / Other error
HTTP/1.1 401 Unauthorized - This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
HTTP/1.1 404 Not Found : The resource requested is not found.
HTTP/1.1 405 Method Not Allowed : The requested action is not supported.
HTTP/1.1 409 Conflict : Already rebooting.

[edit] Alternative URI /servers/{id}/action

An alternative way to execute this call is to omit the accountId portion of the URI. In this case the system assumes the request is executed for the account identified in the authorization header.

POST /servers/{id}/action

Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox