ServerActionStop
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) |
Mike.robski (Talk | contribs) m (1 revision: Release 86) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
The stop action is used for stopping a [[Server]]. Stopping a server changes its status from ACTIVE to STOPPED. | The stop action is used for stopping a [[Server]]. Stopping a server changes its status from ACTIVE to STOPPED. | ||
| − | === | + | ='''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 === | |
<nowiki> | <nowiki> | ||
{ | { | ||
| Line 12: | Line 16: | ||
}</nowiki> | }</nowiki> | ||
| − | + | == 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 23: | Line 27: | ||
: ''HTTP/1.1 409 Conflict'' : Other status change in progress. | : ''HTTP/1.1 409 Conflict'' : Other status change in progress. | ||
| − | + | == 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 [[Authentication|authorization header]]. |
| − | < | + | <code>POST /servers/{id}/action</code> |
| − | + | [[Category:Hostway API]] | |
| − | + | [[Category:FlexCloud Server API]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
Latest revision as of 12:00, 11 October 2013
The stop action is used for stopping a Server. Stopping a server changes its status from ACTIVE to STOPPED.
Contents |
POST /accounts/{accountId}/flexcloud/servers/{id}/action
Parameters
- accountId - string
- The selected account Id.
- id
- The unique identifier of the server to reboot.
JSON
{
"os-stop": null
}
Response Codes
- Success
- HTTP/1.1 202 Accepted : The request is accepted for processing.
- Failure
- HTTP/1.1 400 Bad Request : An error occurred.
- 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 : Other status change in progress.
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
