<back to all web services
VMServerActionReq
Virtuozzo
The following routes are available for this service:| POST | /virtuozzo/vm/server/action | Perform an Action on the Server | |
|---|
VMServerActionReq Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| SessionId | query | string | Yes | The session identifier |
| ServerId | query | string | Yes | The Server unique identifier |
| ProjectId | query | string | Yes | The Project ID unique identifier |
| Action | body | ServerAction | Yes | The requested Server ActionAllowable Values- OsStop
- OsStart
- Suspend
- ResumeSuspend
|
| ActionDetails | body | string | No | The requested Server Action detail information |
ServerAction Enum:| OsStop | |
| OsStart | |
| Suspend | |
| ResumeSuspend | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /virtuozzo/vm/server/action HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<VMServerActionReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Virtuozzo.Request">
<Action>OsStop</Action>
<ActionDetails>String</ActionDetails>
<ProjectId>String</ProjectId>
<ServerId>String</ServerId>
<SessionId>String</SessionId>
</VMServerActionReq>