ServerActionReboot
(Difference between revisions)
| Line 11: | Line 11: | ||
<big><source lang="javascript"> | <big><source lang="javascript"> | ||
{ | { | ||
| − | "reboot": | + | "reboot": |
| − | "type":"HARD" | + | { |
| − | + | "type":"HARD" | |
| − | } | + | } |
| + | } | ||
</source></big> | </source></big> | ||
| − | |||
; type - ''string'' | ; type - ''string'' | ||
: Type of reboot to preform. Values: '''HARD''', '''SOFT'''. | : Type of reboot to preform. Values: '''HARD''', '''SOFT'''. | ||
| − | == | + | == Response Codes == |
| + | ; Success: | ||
| + | :''HTTP/1.1 202 Accepted'' | ||
| + | :The request is accepted for processing. | ||
| + | ; Failure: | ||
| + | :''HTTP/1.1 200 OK 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. | ||
| + | |||
| + | == Examples == | ||
| + | '''Successfully reboot a server''' | ||
| + | :'''POST''' http(s)://{api_server}/167/action | ||
| + | |||
| + | ''Request Headers:'' | ||
| + | Content-Type:application/json | ||
| + | Charset=UTF-8 | ||
| + | Authorization:Base64-encoded username & password string | ||
| + | |||
| + | ''Request Body:'' | ||
| + | { | ||
| + | "reboot": | ||
| + | { | ||
| + | "type":"SOFT" | ||
| + | } | ||
| + | } | ||
| + | |||
| + | ''Response Code:'' | ||
| + | <pre>HTTP/1.1 202 Accepted</pre> | ||
| + | |||
| + | '''Unauthorized access''' | ||
| + | :'''POST''' http(s)://{api_server}/{server_id}/action | ||
| + | |||
| + | |||
| + | ''Request Headers:'' | ||
| + | Content-Type:application/json | ||
| + | Charset=UTF-8 | ||
| + | Authorization:Base64-encoded fake_authentication_string | ||
| + | |||
| + | ''Response Code:'' | ||
| + | <pre>HTTP/1.1 401 Unauthorized</pre> | ||
| + | |||
| + | ''Response Body:'' | ||
| + | 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. | ||
<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | <!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING--> | ||
Revision as of 21:01, 23 April 2012
The reboot function 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.
POST /servers/id/action
Contents |
Parameters
- id
- The unique identifier of the image to be retrieved. Note see warnings in Hypermedia.
JSON
{ "reboot": { "type":"HARD" } }
- type - string
- Type of reboot to preform. Values: HARD, SOFT.
Response Codes
- Success
- HTTP/1.1 202 Accepted
- The request is accepted for processing.
- Failure
- HTTP/1.1 200 OK 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.
Examples
Successfully reboot a server
- POST http(s)://{api_server}/167/action
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded username & password string
Request Body:
{
"reboot":
{
"type":"SOFT"
}
}
Response Code:
HTTP/1.1 202 Accepted
Unauthorized access
- POST http(s)://{api_server}/{server_id}/action
Request Headers:
Content-Type:application/json Charset=UTF-8 Authorization:Base64-encoded fake_authentication_string
Response Code:
HTTP/1.1 401 Unauthorized
Response Body:
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.
